offa / labelled-steps-plugin

Replacement for Jenkins pipeline `sh` step that allows displaying a custom label in the BlueOcean UI.

labelled-steps-plugin

Currently this plugin provides a replacement for the sh, bat and powershell steps in Jenkins pipelines to allow displaying a custom label in the BlueOcean UI.

Why is this needed?

See JENKINS-36933 and JENKINS-37324.

Example

In the following example, the BlueOcean UI will display Building the universe from scratch... as the step title (the step title is the thing you click on to see the shell output):

labelledShell label: 'Building the universe from scratch...', script: """
    echo "Sparking the Big Bang..."
    echo "Cosmic inflation begins..."
    # ...
"""
labelledBatch label: 'Building the universe from scratch...', script: """
    echo "Sparking the Big Bang..."
    echo "Cosmic inflation begins..."
    # ...
"""
labelledPowerShell label: 'Building the universe from scratch...', script: """
    echo "Sparking the Big Bang..."
    echo "Cosmic inflation begins..."
    # ...
"""