cleanup

Author: daspilker

docs/Home.md

@@ -20,6 +20,7 @@ Have a look at the [Jenkins Job DSL Gradle example](https://github.com/sheehan/j
  * Added support for [Build Node Column Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Build+Node+Column+Plugin)
  * Added support for [Pre-SCM Build Step Plugin](https://wiki.jenkins-ci.org/display/JENKINS/pre-scm-buildstep)
  * Added support for [Sonar Plugin](http://docs.sonarqube.org/display/SONAR/Jenkins+Plugin)
+ * Added support for [Debian Package Builder Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Debian+Package+Builder+Plugin)
  * Added `recurse` option for list views
  * Added `ignorePostCommitHooks` option for SCM trigger
  * Added `commentFilePath` option for [GitHub Pull Request Builder Plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin)

docs/Job-reference.md

@@ -139,7 +139,7 @@ freeStyleJob(String name) { // since 1.30
                       boolean flattenFiles, boolean optionalAllowed,
                       Closure copyArtifactClosure)
         criticalBlock(Closure stepClosure) // since 1.24
-        debianPackage(String path, Closure debianClosure)
+        debianPackage(String path, Closure debianClosure = null) // since 1.31
         downstreamParameterized(Closure downstreamClosure)
         dsl(Closure dslClosure)
         dsl(String scriptText, String removedJobAction = null,
@@ -3045,21 +3045,35 @@ When a job is checked the following conditions must be validated before the job
 
 (Since 1.19)
 
-# [Debian Package Builder Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Debian+Package+Builder+Plugin)
+# Debian Package Builder
 
 ```groovy
-debianPackage(String path, Closure debianClosure) {
-    signPackage(true) // Sign package with GPG (key configured in Jenkins settings)
-    generateChangelog(false) // Build changelog from Git
-    buildEvenWhenThereAreNoChanges(false) // Build package if no changes has been made in SCM
+job {
+    step {
+        debianPackage(String path) {
+            signPackage(boolean sign = true) // defaults to true
+            generateChangelog(String nextVersion = null, boolean alwaysBuild = false)
+        }
+    }
 }
 ```
 
-Supports <a href="https://wiki.jenkins-ci.org/display/JENKINS/Debian+Package+Builder+Plugin">the Debian PackageBuilder Plugin</a>.
+Requires the [Debian Package Builder Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Debian+Package+Builder+Plugin).
 
-Path refers to a path in the workspace where the 'debian' catalog is stored.
+The `path` parameter refers to a path in the workspace where the 'debian' catalog is stored. The plugin will
+automatically install packages required to build Debian packages.
 
-The plugin will automatically install packages required to build Debian packages.
+```groovy
+job {
+    step {
+        debianPackage('module') {
+            generateChangelog()
+        }
+    }
+}
+```
+
+(since 1.31)
 
 # [Parameterized Trigger as Build Step](https://wiki.jenkins-ci.org/display/JENKINS/Parameterized+Trigger+Plugin)
 

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

@@ -3,25 +3,18 @@ package javaposse.jobdsl.dsl.helpers.step
 import javaposse.jobdsl.dsl.Context
 
 class DebianContext implements Context {
-    String nextVersion
     boolean generateChangelog
-    boolean signPackage
-    boolean buildEvenWhenThereAreNoChanges
+    String nextVersion
+    boolean alwaysBuild
+    boolean signPackage = true
 
-    void nextVersion(String nextVersion) {
+    void generateChangelog(String nextVersion = null, boolean alwaysBuild = false) {
+        this.generateChangelog = true
         this.nextVersion = nextVersion
+        this.alwaysBuild = alwaysBuild
     }
 
-    void generateChangelog(boolean generateChangelog) {
-        this.generateChangelog = generateChangelog
-    }
-
-    void signPackage(boolean signPackage) {
+    void signPackage(boolean signPackage = true) {
         this.signPackage = signPackage
     }
-
-    void buildEvenWhenThereAreNoChanges(boolean buildEvenWhenThereAreNoChanges) {
-        this.buildEvenWhenThereAreNoChanges = buildEvenWhenThereAreNoChanges
-    }
-
 }

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

@@ -1118,7 +1118,7 @@ class StepContext implements Context {
     }
 
     /**
-     * <ru.yandex.jenkins.plugins.debuilder.DebianPackageBuilder plugin="debian-package-builder@1.6.6">
+     * <ru.yandex.jenkins.plugins.debuilder.DebianPackageBuilder>
      *     <pathToDebian>package</pathToDebian>
      *     <nextVersion></nextVersion>
      *     <generateChangelog>false</generateChangelog>
@@ -1127,19 +1127,19 @@ class StepContext implements Context {
      * </ru.yandex.jenkins.plugins.debuilder.DebianPackageBuilder>
      */
     void debianPackage(String path, @DslContext(DebianContext) Closure closure = null) {
+        jobManagement.requireMinimumPluginVersion('debian-package-builder', '1.6.6')
+
         Preconditions.checkArgument(!isNullOrEmpty(path), 'path must be specified')
 
         DebianContext context = new DebianContext()
         ContextHelper.executeInContext(closure, context)
 
         stepNodes << new NodeBuilder().'ru.yandex.jenkins.plugins.debuilder.DebianPackageBuilder' {
             pathToDebian(path)
-            if (context.nextVersion != null) {
-                nextVersion(context.nextVersion)
-            }
+            nextVersion(context.nextVersion ?: '')
             generateChangelog(context.generateChangelog)
             signPackage(context.signPackage)
-            buildEvenWhenThereAreNoChanges(context.buildEvenWhenThereAreNoChanges)
+            buildEvenWhenThereAreNoChanges(context.alwaysBuild)
         }
     }
 }

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

@@ -2457,35 +2457,35 @@ still-another-dsl.groovy'''
         context.debianPackage('package')
 
         then:
-        context.stepNodes.size() == 1
         with(context.stepNodes[0]) {
             name() == 'ru.yandex.jenkins.plugins.debuilder.DebianPackageBuilder'
+            children().size() == 5
             pathToDebian[0].value() == 'package'
-            signPackage[0].value() == false
+            nextVersion[0].value() == ''
             generateChangelog[0].value() == false
+            signPackage[0].value() == true
             buildEvenWhenThereAreNoChanges[0].value() == false
         }
-
+        _ * jobManagement.requireMinimumPluginVersion('debian-package-builder', '1.6.6')
     }
 
     def 'call debian package with all options'() {
         when:
         context.debianPackage('package') {
-            signPackage(true)
-            generateChangelog(true)
-            buildEvenWhenThereAreNoChanges(true)
+            signPackage(false)
+            generateChangelog('1.0', true)
         }
 
         then:
-        context.stepNodes.size() == 1
         with(context.stepNodes[0]) {
             name() == 'ru.yandex.jenkins.plugins.debuilder.DebianPackageBuilder'
+            children().size() == 5
             pathToDebian[0].value() == 'package'
-            signPackage[0].value() == true
+            nextVersion[0].value() == '1.0'
             generateChangelog[0].value() == true
+            signPackage[0].value() == false
             buildEvenWhenThereAreNoChanges[0].value() == true
         }
-
+        _ * jobManagement.requireMinimumPluginVersion('debian-package-builder', '1.6.6')
     }
-
 }