Merge remote-tracking branch 'upstream/master'

Patrick Wolf · Patrick Wolf · commit 0498c3d32ec1 · 2017-08-15T10:09:30.000-07:00
diff --git a/jenkinsfile-examples/nodejs-build-test-deploy-docker-notify/Jenkinsfile b/jenkinsfile-examples/nodejs-build-test-deploy-docker-notify/Jenkinsfile
@@ -31,48 +31,55 @@ node('node') {
 
     try {
 
-       stage 'Checkout'
+       stage('Checkout'){
 
-            checkout scm
+          checkout scm
+       }
 
-       stage 'Test'
+       stage('Test'){
 
-            env.NODE_ENV = "test"
+         env.NODE_ENV = "test"
 
-            print "Environment will be : ${env.NODE_ENV}"
+         print "Environment will be : ${env.NODE_ENV}"
 
-            sh 'node -v'
-            sh 'npm prune'
-            sh 'npm install'
-            sh 'npm test'
+         sh 'node -v'
+         sh 'npm prune'
+         sh 'npm install'
+         sh 'npm test'
 
-       stage 'Build Docker'
+       }
+
+       stage('Build Docker'){
 
             sh './dockerBuild.sh'
+       }
+
+       stage('Deploy'){
 
-       stage 'Deploy'
+         echo 'Push to Repo'
+         sh './dockerPushToRepo.sh'
 
-            echo 'Push to Repo'
-            sh './dockerPushToRepo.sh'
+         echo 'ssh to web server and tell it to pull new image'
+         sh 'ssh deploy@xxxxx.xxxxx.com running/xxxxxxx/dockerRun.sh'
 
-            echo 'ssh to web server and tell it to pull new image'
-            sh 'ssh deploy@xxxxx.xxxxx.com running/xxxxxxx/dockerRun.sh'
+       }
 
-       stage 'Cleanup'
+       stage('Cleanup'){
 
-            echo 'prune and cleanup'
-            sh 'npm prune'
-            sh 'rm node_modules -rf'
+         echo 'prune and cleanup'
+         sh 'npm prune'
+         sh 'rm node_modules -rf'
 
-            mail body: 'project build successful',
-                        from: 'xxxx@yyyyy.com',
-                        replyTo: 'xxxx@yyyy.com',
-                        subject: 'project build successful',
-                        to: 'yyyyy@yyyy.com'
+         mail body: 'project build successful',
+                     from: 'xxxx@yyyyy.com',
+                     replyTo: 'xxxx@yyyy.com',
+                     subject: 'project build successful',
+                     to: 'yyyyy@yyyy.com'
+       }
 
-        }
 
 
+    }
     catch (err) {
 
         currentBuild.result = "FAILURE"
diff --git a/pipeline-examples/ansi-color-build-wrapper/AnsiColorBuildWrapper.groovy b/pipeline-examples/ansi-color-build-wrapper/AnsiColorBuildWrapper.groovy
@@ -1,8 +1,8 @@
-// This shows a simple build wrapper example, using the AnsiColorBuildWrapper plugin.
+// This shows a simple build wrapper example, using the AnsiColor plugin.
 node {
-    // This is the current syntax for invoking a build wrapper, naming the class.
-    wrap([$class: 'AnsiColorBuildWrapper']) {
+    // This displays colors using the 'xterm' ansi color map.
+    ansiColor('xterm') {
         // Just some echoes to show the ANSI color.
         stage "\u001B[31mI'm Red\u001B[0m Now not"
     }
-}
+}
diff --git a/pipeline-examples/ansi-color-build-wrapper/README.md b/pipeline-examples/ansi-color-build-wrapper/README.md
@@ -1,5 +1,4 @@
 # Synopsis
 
 This shows usage of a simple build wrapper, specifically the
-AnsiColorBuildWrapper plugin, which adds ANSI coloring to the console output.
-
+AnsiColor plugin, which adds ANSI coloring to the console output.
diff --git a/pipeline-examples/artifactory-generic-upload-download/README.md b/pipeline-examples/artifactory-generic-upload-download/README.md
@@ -2,4 +2,4 @@
 
 This is a simple demonstration of how to download dependencies, upload artifacts and publish build info to Artifactory.
 <br>
-Read the full documentation [here](https://wiki.jenkins-ci.org/display/JENKINS/Artifactory+-+Working+With+the+Pipeline+Jenkins+Plugin).
+Read the full documentation [here](https://www.jfrog.com/confluence/display/RTF/Working+With+Pipeline+Jobs+in+Jenkins).
diff --git a/pipeline-examples/artifactory-gradle-build/README.md b/pipeline-examples/artifactory-gradle-build/README.md
@@ -2,4 +2,4 @@
 
 This is a simple demonstration of how to run a Gradle build, that resolves dependencies, upload artifacts and publish build info to Artifactory.
 <br>
-Read the full documentation [here](https://wiki.jenkins-ci.org/display/JENKINS/Artifactory+-+Working+With+the+Pipeline+Jenkins+Plugin).
+Read the full documentation [here](https://www.jfrog.com/confluence/display/RTF/Working+With+Pipeline+Jobs+in+Jenkins).
diff --git a/pipeline-examples/artifactory-gradle-build/artifactoryGradleBuild.groovy b/pipeline-examples/artifactory-gradle-build/artifactoryGradleBuild.groovy
@@ -3,20 +3,25 @@ node {
     def server = Artifactory.server "SERVER_ID"
     // Create an Artifactory Gradle instance.
     def rtGradle = Artifactory.newGradleBuild()
+    def buildInfo
 
-    stage 'Clone sources'
-    git url: 'https://github.com/jfrogdev/project-examples.git'
+    stage('Clone sources') {
+        git url: 'https://github.com/jfrogdev/project-examples.git'
+    }
 
-    stage 'Artifactory configuration'
-    // Tool name from Jenkins configuration
-    rtGradle.tool = "Gradle-2.4"
-    // Set Artifactory repositories for dependencies resolution and artifacts deployment.
-    rtGradle.deployer repo:'ext-release-local', server: server
-    rtGradle.resolver repo:'remote-repos', server: server
+    stage('Artifactory configuration') {
+        // Tool name from Jenkins configuration
+        rtGradle.tool = "Gradle-2.4"
+        // Set Artifactory repositories for dependencies resolution and artifacts deployment.
+        rtGradle.deployer repo:'ext-release-local', server: server
+        rtGradle.resolver repo:'remote-repos', server: server
+    }
 
-    stage 'Gradle build'
-    def buildInfo = rtGradle.run rootDir: "gradle-examples/4/gradle-example-ci-server/", buildFile: 'build.gradle', tasks: 'clean artifactoryPublish'
+    stage('Gradle build') {
+        buildInfo = rtGradle.run rootDir: "gradle-examples/4/gradle-example-ci-server/", buildFile: 'build.gradle', tasks: 'clean artifactoryPublish'
+    }
 
-    stage 'Publish build info'
-    server.publishBuildInfo buildInfo
+    stage('Publish build info') {
+        server.publishBuildInfo buildInfo
+    }
 }
diff --git a/pipeline-examples/artifactory-maven-build/README.md b/pipeline-examples/artifactory-maven-build/README.md
@@ -2,4 +2,4 @@
 
 This is a simple demonstration of how to run a Maven build, that resolves dependencies, upload artifacts and publish build info to Artifactory.
 <br>
-Read the full documentation [here](https://wiki.jenkins-ci.org/display/JENKINS/Artifactory+-+Working+With+the+Pipeline+Jenkins+Plugin).
+Read the full documentation [here](https://www.jfrog.com/confluence/display/RTF/Working+With+Pipeline+Jobs+in+Jenkins).
diff --git a/pipeline-examples/artifactory-maven-build/artifactoryMavenBuild.groovy b/pipeline-examples/artifactory-maven-build/artifactoryMavenBuild.groovy
@@ -3,20 +3,25 @@ node {
     def server = Artifactory.server "SERVER_ID"
     // Create an Artifactory Maven instance.
     def rtMaven = Artifactory.newMavenBuild()
+    def buildInfo
 
-    stage 'Clone sources'
-    git url: 'https://github.com/jfrogdev/project-examples.git'
+    stage('Clone sources') {
+        git url: 'https://github.com/jfrogdev/project-examples.git'
+    }
 
-    stage 'Artifactory configuration'
-    // Tool name from Jenkins configuration
-    rtMaven.tool = "Maven-3.3.9"
-    // Set Artifactory repositories for dependencies resolution and artifacts deployment.
-    rtMaven.deployer releaseRepo:'libs-release-local', snapshotRepo:'libs-snapshot-local', server: server
-    rtMaven.resolver releaseRepo:'libs-release', snapshotRepo:'libs-snapshot', server: server
+    stage('Artifactory configuration') {
+        // Tool name from Jenkins configuration
+        rtMaven.tool = "Maven-3.3.9"
+        // Set Artifactory repositories for dependencies resolution and artifacts deployment.
+        rtMaven.deployer releaseRepo:'libs-release-local', snapshotRepo:'libs-snapshot-local', server: server
+        rtMaven.resolver releaseRepo:'libs-release', snapshotRepo:'libs-snapshot', server: server
+    }
 
-    stage 'Maven build'
-    def buildInfo = rtMaven.run pom: 'maven-example/pom.xml', goals: 'clean install'
+    stage('Maven build') {
+        buildInfo = rtMaven.run pom: 'maven-example/pom.xml', goals: 'clean install'
+    }
 
-    stage 'Publish build info'
-    server.publishBuildInfo buildInfo
+    stage('Publish build info') {
+        server.publishBuildInfo buildInfo
+    }
 }
diff --git a/pipeline-examples/configfile-provider-plugin/README.md b/pipeline-examples/configfile-provider-plugin/README.md
@@ -0,0 +1,10 @@
+[configFile Provider plugin](https://plugins.jenkins.io/config-file-provider) enables provisioning of various types of configuration files. Plugin works in such a way as to make the configuration available for the entire duration of the build across all the build agents that are used to execute the build.
+
+Common scenarios that demand the usage of configuration files:
+
+- Provide properties that can be consumed by the build tool
+- Global settings that override local settings
+- Details of credentials needed to access repos
+- Inputs to generate binary images that need to be tailored to specific architectures 
+
+The example shows simple usage of configFile Provider plugin and howto access it's contents.
diff --git a/pipeline-examples/configfile-provider-plugin/configFileProvider.groovy b/pipeline-examples/configfile-provider-plugin/configFileProvider.groovy
@@ -0,0 +1,30 @@
+#!groovy
+
+node {
+    stage('configFile Plugin') {
+
+        // 'ID' refers to alpha-numeric value generated automatically by Jenkins.
+        // This code snippet assumes that the config file is stored in Jenkins.
+
+        // help to assign the ID of config file to a variable, this is optional 
+        // as ID can be used directly within 'configFileProvider' step too.
+        def mycfg_file = '<substitute-alpha-numeric-value-cfgfille-here-within-quotes>'
+
+        // whether referencing the config file as ID (directly) or via user-defined 
+        // variable, 'configFileProvider' step enables access to the config file
+        // via 'name' given for the field, 'variable:'
+        configFileProvider([configFile(fileId: mycfg_file, variable: 'PACKER_OPTIONS')]) {
+            echo " =========== ^^^^^^^^^^^^ Reading config from pipeline script "
+            sh "cat ${env.PACKER_OPTIONS}"
+            echo " =========== ~~~~~~~~~~~~ ============ "
+ 
+            // Access to config file opens up other possibilities like
+            // passing on the configuration to an external script for other tasks, like,
+            // for example, to set generic options that can be used for generating 
+            // binary images using packer.
+            echo " =========== ^^^^^^^^^^^^ Reading config via Python... "
+            sh "python build_image.py ${env.PACKER_OPTIONS}"
+            echo " =========== ~~~~~~~~~~~~ ============ "
+        }
+    }
+}
diff --git a/pipeline-examples/external-workspace-manager/externalWorkspace.groovy b/pipeline-examples/external-workspace-manager/externalWorkspace.groovy
@@ -27,7 +27,7 @@ node('test') {
         } finally {
             // perform workspace cleanup only if the build have passed
             // if the build has failed, the workspace will be kept
-            step([$class: 'WsCleanup', cleanWhenFailure: false])
+            cleanWs cleanWhenFailure: false
         }
     }
 }
diff --git a/pipeline-examples/gitcommit/gitcommit.groovy b/pipeline-examples/gitcommit/gitcommit.groovy
@@ -1,5 +1,5 @@
 // These should all be performed at the point where you've
-// checked out your sources on the slave. A 'git' executable
+// checked out your sources on the agent. A 'git' executable
 // must be available.
 // Most typical, if you're not cloning into a sub directory
 gitCommit = sh(returnStdout: true, script: 'git rev-parse HEAD').trim()
diff --git a/pipeline-examples/gitcommit_changeset/README.md b/pipeline-examples/gitcommit_changeset/README.md
@@ -0,0 +1,4 @@
+# Synopsis
+
+Demonstrate how to retrieve the changeset associated with a git commit to a Pipeline job.
+
diff --git a/pipeline-examples/gitcommit_changeset/gitcommit_changeset.groovy b/pipeline-examples/gitcommit_changeset/gitcommit_changeset.groovy
@@ -0,0 +1,9 @@
+// This should be performed at the point where you've
+// checked out your sources on the agent. A 'git' executable
+// must be available.
+// Most typical, if you're not cloning into a sub directory
+// and invoke this in the context of a directory with .git/
+// Along with SHA-1 id of the commit, it will be useful to retrieve changeset associated with that commit
+// This command results in output indicating several one of these and the affected files:
+// Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R)
+commitChangeset = sh(returnStdout: true, script: 'git diff-tree --no-commit-id --name-status -r HEAD').trim()
diff --git a/pipeline-examples/jobs-in-parallel/jobs_in_parallel.groovy b/pipeline-examples/jobs-in-parallel/jobs_in_parallel.groovy
@@ -11,10 +11,11 @@ for (int i = 0; i < 4; i++) {
   branches["branch${i}"] = {
 //Parameters:
 //param1 : an example string parameter for the triggered job.
-//dummy: a parameter used to prevent triggering the job with the same parameters value. this parameter has to accept a different value
-//each time the job is triggered.
-    build job: 'test_jobs', parameters: [[$class: 'StringParameterValue', name: 'param1', value:
-      'test_param'], [$class: 'StringParameterValue', name:'dummy', value: "${index}"]]
-    }
+//dummy: a parameter used to prevent triggering the job with the same parameters value.
+//       this parameter has to accept a different value each time the job is triggered.
+    build job: 'freestyle', parameters: [
+      string(name: 'param1', value:'test_param'),
+      string(name:'dummy', value: "${index}")]
+  }
 }
 parallel branches
diff --git a/pipeline-examples/parallel-from-list/README.md b/pipeline-examples/parallel-from-list/README.md
@@ -5,14 +5,6 @@ a map of steps to be run with the parallel command.
 
 # Caveats
 
-* Due to limitations in Pipeline - i.e.,
-[JENKINS-26481](https://issues.jenkins-ci.org/browse/JENKINS-26481) -
-it's not really possible to use Groovy closures or syntax that depends
-on closures, so you can't do the Groovy standard of using
-.collectEntries on a list and generating the steps as values for the
-resulting entries. You also can't use the standard Java syntax for For
-loops - i.e., "for (String s: strings)" - and instead have to use old
-school counter-based for loops.
 * There is no need for the generation of the step itself to be in a
 separate method. I've opted to do so here to show how to return a step
 closure from a method.
diff --git a/pipeline-examples/parallel-from-list/parallelFromList.groovy b/pipeline-examples/parallel-from-list/parallelFromList.groovy
@@ -6,20 +6,8 @@
 def stringsToEcho = ["a", "b", "c", "d"]
 
 // The map we'll store the parallel steps in before executing them.
-def stepsForParallel = [:]
-
-// The standard 'for (String s: stringsToEcho)' syntax also doesn't work, so we
-// need to use old school 'for (int i = 0...)' style for loops.
-for (int i = 0; i < stringsToEcho.size(); i++) {
-    // Get the actual string here.
-    def s = stringsToEcho.get(i)
-
-    // Transform that into a step and add the step to the map as the value, with
-    // a name for the parallel step as the key. Here, we'll just use something
-    // like "echoing (string)"
-    def stepName = "echoing ${s}"
-    
-    stepsForParallel[stepName] = transformIntoStep(s)
+def stepsForParallel = stringsToEcho.collectEntries {
+    ["echoing ${it}" : transformIntoStep(it)]
 }
 
 // Actually run the steps in parallel - parallel takes a map as an argument,
diff --git a/pipeline-examples/push-git-repo/pushGitRepo.Groovy b/pipeline-examples/push-git-repo/pushGitRepo.Groovy
@@ -5,10 +5,13 @@
 
 // credentialsId here is the credentials you have set up in Jenkins for pushing
 // to that repository using username and password.
-withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'MyID', usernameVariable: 'GIT_USERNAME', passwordVariable: 'GIT_PASSWORD']]) {
-
+withCredentials([usernamePassword(credentialsId: 'git-pass-credentials-ID', passwordVariable: 'GIT_PASSWORD', usernameVariable: 'GIT_USERNAME')]) {
     sh("git tag -a some_tag -m 'Jenkins'")
     sh('git push https://${GIT_USERNAME}:${GIT_PASSWORD}@<REPO> --tags')
 }
 
 // For SSH private key authentication, try the sshagent step from the SSH Agent plugin.
+sshagent (credentials: ['git-ssh-credentials-ID']) {
+    sh("git tag -a some_tag -m 'Jenkins'")
+    sh('git push <REPO> --tags')
+}
diff --git a/pipeline-examples/timestamper-wrapper/timestamperWrapper.groovy b/pipeline-examples/timestamper-wrapper/timestamperWrapper.groovy
@@ -1,6 +1,6 @@
 // This shows a simple build wrapper example, using the Timestamper plugin.
 node {
-    // This is the current syntax for invoking a build wrapper, naming the class.
+    // Adds timestamps to the output logged by steps inside the wrapper.
     timestamps {
         // Just some echoes to show the timestamps.
         stage "First echo"
