Jenkins Description Setter Plugin for Improving Continuous Delivery Visibility

Alex SotoJanuary 29th, 2013Last Updated: January 29th, 2013

1 46 2 minutes read

In Continuous Delivery each build is potentially shippable. This fact implies among a lot of other things, to assign a none snapshot version to your components as fast as possible so you can refer them through all the process. I suggest creating a release branch, assign the version to the project and then start the typical pipeline (compile, tests, code quality …) steps to release branch.

If you are using Jenkins, your build job screen will look something like:

Note that we have released the project many times, but there is no quick way to know exactly which version has been constructed in build number 40. To avoid this problem and having a quick overview of which version has been executed in each build job instance, we can use Jenkins description setter plugin. This plugin sets the description for each build, based upon a regular expression of the build log file. So your build job screen will look something like:

Much better, now we know exactly the result of a build job and which product version has been generated. So first step is installing the plugin by simply going to: Jenkins -> Manage Jenkins -> Manage Plugins -> Available. After installation you can open Build Job configuration screen and add a post-build action called ‘ Set build description‘. Then add a regular expression for extracting the version number. In this case the regular expression is: \[INFO\] from version 0\.0\.1-SNAPSHOT to (.*)

Take a look at next fragment of build log file:

         

          [INFO] Scanning for projects...

          [INFO]                                                                         

          [INFO] ------------------------------------------------------------------------

          [INFO] Building hello 0.0.1-SNAPSHOT

          [INFO] ------------------------------------------------------------------------

          [INFO] 

          [INFO] --- versions-maven-plugin:2.0:set (default-cli) @ hello ---

          [INFO] Searching for local aggregator root...

          [INFO] Local aggregation root: /jobs/helloworld-inital-build/workspace

          [INFO] Processing com.lordofthejars.helloworld:hello

          [INFO]     Updating project com.lordofthejars.helloworld:hello

          [INFO]         from version 0.0.1-SNAPSHOT to 1.0.43

          Props: {project.version=1.0.43, project.artifactId=hello, project.groupId=com.lordofthejars.helloworld}

At line 12 we are logging the final version of our product for current pipeline execution, so we create a regular expression which parses that line and the part between brackets are used as decorator. Depending on log traces the regular expression will differ from this one. In this case, we are always using the same SNAPSHOT version in development and only when product is going to be released (this could be 3 times per day or every night) the final version is generated and set. Hope this plugin helps you to make your builds more clear.

Reference: Jenkins Description Setter Plugin for Improving Continuous Delivery Visibility from our JCG partner Alex Soto at the One Jar To Rule Them All blog.