Merge pull request #295 from bondezbond/master

added docs on withEnv & withGlobalEnv

Author: kmanning

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+* [Issue #293](https://github.com/manheim/terraform-pipeline/issues/293) withEnv & withGlobalEnv docs
+
 # v5.10
 
 * [Issue #289](https://github.com/manheim/terraform-pipeline/issues/289) TagPlugin should work with both terraform 0.11.x and 0.12.x

README.md

@@ -205,8 +205,9 @@ 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.
 
-# Additional Pipeline Stages
+# Pipeline Stages
 
+* [TerraformEnvironmentStage](./docs/TerraformEnvironmentStage.md) - run terraform plan & apply
 * [BuildStage](./docs/BuildStage.md) - build a deployment artifact that will subsequently be used by TerraformEnvironmentStage.
 * [RegressionStage](./docs/RegressionStage.md) - run automated tests against an environment
 

docs/TerraformEnvironmentStage.md

@@ -0,0 +1,44 @@
+## [TerraformEnvironmentStage](../src/TerraformEnvironmentStage.groovy)
+
+### Pass in Global Environment variable
+
+You can pass in global environment variables too all stages in your pipeline using `withGlobalEnv`
+
+```
+// Jenkinsfile
+@Library(['terraform-pipeline']) _
+
+Jenkinsfile.init(this)
+
+TerraformEnvironmentStage.withGlobalEnv('KEY_01', 'VALUE_01')
+                         .withGlobalEnv('KEY_01', 'VALUE_02')
+
+def validate = new TerraformValidateStage()
+def deployQA = new TerraformEnvironmentStage('qa')
+def deployProd = new TerraformEnvironmentStage('prod')
+
+validate.then(deployQA)
+        .then(deployProd)
+        .build()
+```
+
+### Pass in Stage Specific Environment variable
+
+You can pass in stage specific environment variables each stage in your pipeline using `withEnv`
+
+```
+// Jenkinsfile
+@Library(['terraform-pipeline']) _
+
+Jenkinsfile.init(this)
+
+def validate = new TerraformValidateStage()
+def deployQA = new TerraformEnvironmentStage('qa').withEnv('KEY_01', 'VALUE_01')
+                                                  .withEnv('KEY_02', 'VALUE_02')
+def deployProd = new TerraformEnvironmentStage('prod').withEnv('KEY_03', 'VALUE_03')
+                                                      .withEnv('KEY_04', 'VALUE_04')
+
+validate.then(deployQA)
+        .then(deployProd)
+        .build()
+```