Merge pull request #1425 from abayer/jenkins-49226

[JENKINS-49226] Documentation for new equals condition
jenkins-infra · Apr 6, 2018 · 4e52668 · 4e52668
2 parents 4381e18 + 60f9e48
commit 4e52668
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/content/doc/book/pipeline/syntax.adoc b/content/doc/book/pipeline/syntax.adoc
@@ -878,6 +878,9 @@ a multibranch Pipeline.
 environment:: Execute the stage when the specified environment variable is set
 to the given value, for example: `when { environment name: 'DEPLOY_TO', value: 'production' }`
 
+equals:: Execute the stage when the expected value is equal to the actual value,
+for example: `when { equals expected: 2, actual: currentBuild.number }`
+
 expression:: Execute the stage when the specified Groovy expression evaluates
 to true, for example: `when { expression { return params.DEBUG_BUILD } }`