cleanup

Author: daspilker

docs/Home.md

@@ -33,6 +33,7 @@ Have a look at the [Jenkins Job DSL Gradle example](https://github.com/sheehan/j
  * Enhanced support for the [Multijob Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Multijob+Plugin)
  * Enhanced support for the [NodeJS Plugin](https://wiki.jenkins-ci.org/display/JENKINS/NodeJS+Plugin)
  * Enhanced support for the [Maven Project Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Maven+Project+Plugin)
+ * Enhanced support for the [Description Setter Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Description+Setter+Plugin)
  * The `tagFilterRegex` argument of `listTagsParam` can be null or empty
  * The enum argument of `localRepository` for the Maven job and context has changed, see [[Migration]]
  * Support for the older versions of the [Multijob Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Multijob+Plugin) is deprecated, see [[Migration]]

docs/Job-reference.md

@@ -130,7 +130,7 @@ freeStyleJob(String name) { // since 1.30
         ant(String targets, String buildFile, String antInstallation,
             Closure antClosure = null)
         batchFile(String command)
-        buildDescription(String regexp, String text) // since 1.31
+        buildDescription(String regexp, String description = null) // since 1.31
         conditionalSteps(Closure conditionalClosure)
         copyArtifacts(String jobName, String includeGlob, Closure copyArtifactClosure)
         copyArtifacts(String jobName, String includeGlob, String targetPath,
@@ -2377,13 +2377,26 @@ batchFile(String commandStr)
 Supports running a Windows batch file as a build step.
 
 ### Build Description
+
 ```groovy
-buildDescription(String regexpStr, String descriptionStr)
+job {
+    steps {
+        buildDescription(String regexp, String description = null)
+    }
+}
 ```
 
-Set build description based upon a RegEx test of the log file, as a build step.
+Set build description based upon a regular expression test of the log file.
 Requires the [Description Setter Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Description+Setter+Plugin)
 
+```groovy
+job('example') {
+    steps {
+        buildDescription(/.*\[INFO\] Uploading project information for [^\s]* ([^\s]*)/)
+    }
+}
+```
+
 ### Gradle
 
 ```groovy

job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/helpers/step/StepContext.groovy

@@ -34,11 +34,11 @@ class StepContext implements Context {
         }
     }
 
-    void buildDescription(String regexpStr, String descriptionStr) {
-        NodeBuilder nodeBuilder = new NodeBuilder()
-        stepNodes << nodeBuilder.'hudson.plugins.descriptionsetter.DescriptionSetterBuilder' {
-            'regexp' regexpStr
-            'description' descriptionStr
+    @RequiresPlugin(id = 'description-setter', minimumVersion = '1.9')
+    void buildDescription(String regexp, String description = null) {
+        stepNodes << new NodeBuilder().'hudson.plugins.descriptionsetter.DescriptionSetterBuilder' {
+            delegate.regexp(regexp ?: '')
+            delegate.description(description ?: '')
         }
     }
 

job-dsl-core/src/test/groovy/javaposse/jobdsl/dsl/helpers/step/StepContextSpec.groovy

@@ -37,17 +37,32 @@ class StepContextSpec extends Specification {
         shellStep.command[0].value() == 'echo "Hello from Windows"'
     }
 
-    def 'call buildDescription method'() {
+    def 'call buildDescription method with all options'() {
         when:
         context.buildDescription('[version] (.*)', 'foo \\1')
 
         then:
-        context.stepNodes != null
-        context.stepNodes.size() == 1
-        def descStep = context.stepNodes[0]
-        descStep.name() == 'hudson.plugins.descriptionsetter.DescriptionSetterBuilder'
-        descStep.description[0].value() == 'foo \\1'
-        descStep.regexp[0].value() == '[version] (.*)'
+        with(context.stepNodes[0]) {
+            name() == 'hudson.plugins.descriptionsetter.DescriptionSetterBuilder'
+            children().size() == 2
+            regexp[0].value() == '[version] (.*)'
+            description[0].value() == 'foo \\1'
+        }
+        _ * jobManagement.requireMinimumPluginVersion('description-setter', '1.9')
+    }
+
+    def 'call buildDescription method with minimum options'() {
+        when:
+        context.buildDescription('[version] (.*)')
+
+        then:
+        with(context.stepNodes[0]) {
+            name() == 'hudson.plugins.descriptionsetter.DescriptionSetterBuilder'
+            children().size() == 2
+            regexp[0].value() == '[version] (.*)'
+            description[0].value() == ''
+        }
+        _ * jobManagement.requireMinimumPluginVersion('description-setter', '1.9')
     }
 
     def 'call gradle methods'() {