Jenkins pipeline plugin: set the build description

53
votes

I'm trying to replace our current build pipeline, currently hacked together using old-school Jenkins jobs, with a new job that uses the Jenkins pipeline plugin, and loads a Jenkinsfile from the project repository.

One thing that the legacy job did was set the build description to include the Mercurial hash, username and current version using the Description setter plugin, so that builds are easy to find.

Is there a way to replicate/emulate this behaviour with the Jenkins pipeline plugin?

4
jenkinsjenkins-pipelinejenkins-workflow
There is no way to do it in declarative pipeline. See this q & a: support.cloudbees.com/hc/en-us/articles/… – apanzerj
Related: stackoverflow.com/q/43639099/357774. – Noyo
Now we just need a nice way to get regex matching strings out of the console.log ... – MarkHu

4 Answers

91
votes

Just figured it out. The pipeline job exposes a currentBuild global variable with writable properties. Setting the description can be done with:

currentBuild.description = "my new description"

anywhere in the pipeline script. More information in this DZone tutorial.

26
votes

The answer from @jjst describes how to set the build description in "scripted pipelines". In declarative pipelines you can do the same, but need to place it inside a script { } block. Here an example taken from comments on the Cloudbees article:

pipeline {
    agent any
    stages {
        stage("1st stage") {
            steps {
                script {
                    currentBuild.displayName = "My custom build name"
                    currentBuild.description = "My custom build description"
                }
            }
        }
    }
}
6
votes

This may not have been the case when jjst wrote his answer but now with the latest jenkins and plugins you can set this outside the main pipeline at the top. This means you dont have to embed script setting and have special steps etc eg

currentBuild.description = "my new description"
pipeline {...

or

currentBuild.description = """
blah
blah
blah
"""
pipeline {
1
votes

I'm not sure how old it is, but I recently discovered the buildDescription plugin that gives you a declarative method to set the build description. Once installed, it's as easy as:

steps {
  buildDescription 'my build'
}

The console will show a step output: New run description is 'my build'