Merge pull request #434 from duckpuppy/change_master_to_main

Fixes #372 - Change default branch from `master` to `main`

Author: duckpuppy

.gitignore

@@ -5,3 +5,8 @@ build
 .idea
 *.iml
 /out
+.history
+tags
+.vscode
+shell.nix
+nix/

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Unreleased
 
+- [Issue #372](https://github.com/manheim/terraform-pipeline/issues/372) Replace `master` branch with `main` in documentation
+- [Issue #372](https://github.com/manheim/terraform-pipeline/issues/372)
+  ConditionalApplyPlugin: Support main and master branches
+- [Issue #372](https://github.com/manheim/terraform-pipeline/issues/372)
+  TerraformTaintPlugin: Support main and master branches
 - [Issue #432](https://github.com/manheim/terraform-pipeline/issues/432) pass TagPlugin through `-var-file={env}-tags.tfvars`
 - [Issue #417](https://github.com/manheim/terraform-pipeline/issues/417) DestroyPlugin & PassPlanFilePlugin - Terraform Destroy can't be called with a plan file
 

README.md

@@ -9,7 +9,7 @@ A reusable pipeline template to apply terraform configuration serially across mu
     2.  `terraform plan`
     3.  `terraform apply`
 2.  After running a terraform plan, your pipeline will pause.  A human must review and confirm the plan before `terraform apply` is run.  See: [ConfirmApplyPlugin](./docs/ConfirmApplyPlugin.md).
-3.  When running your pipeline on a branch, only the `terraform init` and `terraform plan` commands will be run across all of your environments.  `terraform apply` is only made available on the master branch. See: [ConditionalApplyPlugin](./docs/ConditionalApplyPlugin.md).
+3.  When running your pipeline on a branch, only the `terraform init` and `terraform plan` commands will be run across all of your environments.  `terraform apply` is only made available on the main branch. See: [ConditionalApplyPlugin](./docs/ConditionalApplyPlugin.md).
 4.  If your environments might create conflicting resources, a TF_VAR_environment variable is automatically available to your project and can be used to namespace your resources and avoid conflicts. See: [DefaultEnvironmentPlugin](./docs/DefaultEnvironmentPlugin.md).
 5.  Import terraform-pipeline as a Jenkinsfile library to your Jenkins instance.
 ![Importing Pipeline Library](./images/import-terraform-pipeline.png)
@@ -95,7 +95,7 @@ The example above gives you a bare-bones pipeline, and there may be Jenkinsfile
 ### Default Plugins
 * [BuildWithParametersPlugin](./docs/BuildWithParametersPlugin.md): use this plugin to manage the "Build with Parameters" feature of pipelines.
 * [ConfirmApplyPlugin](./docs/ConfirmApplyPlugin.md): pause and review the plan, before applying any changes.
-* [ConditionalApplyPlugin](./docs/ConditionalApplyPlugin.md): only allow apply on master branch.
+* [ConditionalApplyPlugin](./docs/ConditionalApplyPlugin.md): only allow apply on main branch.
 * [DefaultEnvironmentPlugin](./docs/DefaultEnvironmentPlugin.md): automatically set `TF_VAR_environment` variable.
 * [TerraformPlugin](./docs/TerraformPlugin.md): apply version-specific terraform behavior based on the version of terraform in use.
 ### Credentials and Configuration Management
@@ -208,7 +208,7 @@ By default, the pipeline jobs are not assigned to a particular Jenkins slave lab
 Jenkinsfile.defaultNodeName = 'myNode'
 ```
 
-Alternatively, you can assign all of your pipelines to a particular Jenkins slave label without using code, by setting a `DEFAULT_NODE_NAME` environment variable on your Jenkins master.
+Alternatively, you can assign all of your pipelines to a particular Jenkins agent label without using code, by setting a `DEFAULT_NODE_NAME` environment variable on your Jenkins server.
 
 # Pipeline Stages
 
@@ -403,4 +403,4 @@ If no `.terraform-version` file is found, and no explicit version is provided, t
     2.  It should be possible to add behaviors through Plugins and Decorations - this makes behavior addable/removable/extenable.
     3.  Think of plugins as interchangeable Lego pieces - you can swap one piece out for another, without fundamentally altering what it is to be a Pipeline.
 4.  There should only be one way to Production, and that way should be crystal clear.
-    1.  The master branch (or its equivalent) is the one-and-only way to Production.
+    1.  The main branch (or its equivalent) is the one-and-only way to Production.

docs/AnsiColorPlugin.md

@@ -3,7 +3,7 @@
 Enable this plugin to color the output for terraform plan and apply.
 
 One-time setup:
-* Install the [AnsiColorPlugin](https://wiki.jenkins.io/display/JENKINS/AnsiColor+Plugin) on your Jenkins master.
+* Install the [AnsiColorPlugin](https://wiki.jenkins.io/display/JENKINS/AnsiColor+Plugin) on your Jenkins server.
 
 ```
 // Jenkinsfile

docs/ConditionalApplyPlugin.md

@@ -2,7 +2,12 @@
 
 This plugin is enabled by default.
 
-By default, changes are applied through one and only one branch - master.  The ConditionalApplyPlugin enforces this by making the "Confirm" and "Apply" steps of a TerraformEnvironmentStage visible only on the master branch.  You can continue to use branches and PullRequests, however, branches and PullRequests will only run the Plan step for each environment, and skip over the Confirm/Apply steps.
+By default, changes are applied through one and only one branch - main.  The
+ConditionalApplyPlugin enforces this by making the "Confirm" and "Apply" steps
+of a TerraformEnvironmentStage visible only on the main or master branch.  You can
+continue to use branches and PullRequests, however, branches and PullRequests
+will only run the Plan step for each environment, and skip over the
+Confirm/Apply steps.
 
 This behavior can be changed by using `ConditionalApplyPlugin.withApplyOnBranch()`.  This method accepts one or more branches.  "Confirm" and "Apply" steps of TerraformEnvironmentStage will then be visible for each of the specified branches.  Any branch or PullRequest not in that list will only run the Plan step for each environment, and skip over the Confirm/Apply steps.
 
@@ -12,16 +17,16 @@ Example:
 @Library(['terraform-pipeline']) _
 
 Jenkinsfile.init(this)
-ConditionalApplyPlugin.withApplyOnBranch('myMasterReplacement')
+ConditionalApplyPlugin.withApplyOnBranch('myMainReplacement')
 
 def validate = new TerraformValidateStage()
-// 'qa' stage will run Plan/Confirm/Apply on the 'myMasterReplacement' branch.
+// 'qa' stage will run Plan/Confirm/Apply on the 'myMainReplacement' branch.
 // 'qa' stage will only run Plan for all other branches and PullRequests.
 def deployQa = new TerraformEnvironmentStage('qa')
-// 'uat' stage will run Plan/Confirm/Apply on 'myMasterReplacement' branch.
+// 'uat' stage will run Plan/Confirm/Apply on 'myMainReplacement' branch.
 // 'uat' stage will only run Plan for all other branches and PullRequests.
 def deployUat = new TerraformEnvironmentStage('uat')
-// 'prod' stage will run Plan/Confirm/Apply on 'myMasterReplacement' branch.
+// 'prod' stage will run Plan/Confirm/Apply on 'myMainReplacement' branch.
 // 'prod' stage will only run Plan for all other branches and PullRequests.
 def deployProd = new TerraformEnvironmentStage('prod')
 
@@ -45,9 +50,9 @@ ConditionalApplyPlugin.withApplyOnEnvironment('qa')
 def validate = new TerraformValidateStage()
 // 'qa' stage will run Plan/Confirm/Apply on all branches and PullRequests.
 def deployQa = new TerraformEnvironmentStage('qa')
-// 'uat' stage will run Plan/Confirm/Apply only on master, and will only run Plan on all other branches and PullRequests.
+// 'uat' stage will run Plan/Confirm/Apply only on main, and will only run Plan on all other branches and PullRequests.
 def deployUat = new TerraformEnvironmentStage('uat')
-// 'prod' stage will run Plan/Confirm/Apply only on master, and will only run Plan on all other branches and PullRequests.
+// 'prod' stage will run Plan/Confirm/Apply only on main, and will only run Plan on all other branches and PullRequests.
 def deployProd = new TerraformEnvironmentStage('prod')
 
 validate.then(deployQa)

docs/CredentialsPlugin.md

@@ -3,7 +3,7 @@
 Enable this plugin to inject credentials into your stages using the [Jenkins Credentials Plugin](https://wiki.jenkins.io/display/JENKINS/Credentials+Plugin).
 
 One-time setup:
-* Install the [Jenkins Credentials Binding Plugin](https://www.jenkins.io/doc/pipeline/steps/credentials-binding/) on your Jenkins master.
+* Install the [Jenkins Credentials Binding Plugin](https://www.jenkins.io/doc/pipeline/steps/credentials-binding/) on your Jenkins server.
 * Define a credential that you want to inject.
 
 Add any number of credentials bindings that you want to wrap your stages, with `withBinding`.  Each call to this method will cumulatively add more credentials.  See the [Credentials Binding Plugin homepage](https://www.jenkins.io/doc/pipeline/steps/credentials-binding/) for the list of supported bindings.

docs/ParameterStoreBuildWrapperPlugin.md

@@ -3,7 +3,7 @@
 Enable this plugin to inject variables using the [AWS Parameter Store Build Wrapper Plugin](https://plugins.jenkins.io/aws-parameter-store)
 
 One-time step:
-* Install the AWS Parameter Store Build Wrapper Plugin on your Jenkins master
+* Install the AWS Parameter Store Build Wrapper Plugin on your Jenkins server
 * For cross-account deployments, create an AWS Credential with the id '<ENVIRONMENT>_PARAMETER_STORE_ACCESS' that provides access to ParameterStore for that account.
 
 By default, parameters will be retrieved from the ParameterStore path constructed from your project's Git Organization, Git Repository name, and environment.  Eg: If my terraform project were at https://github.com/Manheim/fake-terraform-project, then my 'qa' environment would receive parameters from the ParameterStore path '/Manheim/fake-terraform-project/qa'.

docs/TerraformTaintPlugin.md

@@ -21,7 +21,7 @@ There are several ways to customize where and when the taint/untaint can run:
 Jenkinsfile.init(this, env)
 
 // This enables the "taint" and "untaint" functionality
-// It will only apply to the master branch (default behavior)
+// It will only apply to the main branch (default behavior)
 TerraformTaintPlugin.init()
 
 def validate = new TerraformValidateStage()

src/ConditionalApplyPlugin.groovy

@@ -4,7 +4,7 @@ import static TerraformEnvironmentStage.APPLY
 public class ConditionalApplyPlugin implements TerraformEnvironmentStagePlugin, Resettable {
 
     private static enabled = true
-    private static DEFAULT_BRANCHES = ['master']
+    private static DEFAULT_BRANCHES = ['main', 'master']
     private static branches = DEFAULT_BRANCHES
     private static environments = []
 

src/RegressionStage.groovy

@@ -48,13 +48,13 @@ class RegressionStage implements Stage, DecoratableStage, Resettable {
                             checkout scm
                             sh testCommand
                         } else if (automationRepoList.size() == 1) {
-                            checkout resolveScm(source: [$class: 'GitSCMSource', remote: automationRepoList.first(), traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait'], [$class: 'LocalBranchTrait']]], targets: [BRANCH_NAME, 'master'])
+                            checkout resolveScm(source: [$class: 'GitSCMSource', remote: automationRepoList.first(), traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait'], [$class: 'LocalBranchTrait']]], targets: [BRANCH_NAME, 'main'])
                             sh testCommand
                         } else {
                             for (url in automationRepoList) {
                                 def dirName = url.split('/').last() - '.git'
                                 dir(dirName) {
-                                    checkout resolveScm(source: [$class: 'GitSCMSource', remote: url, traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait'], [$class: 'LocalBranchTrait']]], targets: [BRANCH_NAME, 'master'])
+                                    checkout resolveScm(source: [$class: 'GitSCMSource', remote: url, traits: [[$class: 'jenkins.plugins.git.traits.BranchDiscoveryTrait'], [$class: 'LocalBranchTrait']]], targets: [BRANCH_NAME, 'main'])
                                 }
                             }