Jenkins pipeline plugin: set the build description

Question

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.

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 a complete working example taken from comments on a Cloudbees article:

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

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 {

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'