This plugin allows users to add badges and build summary entries from a pipeline.
Since version 1.10 release notes are recorded in GitHub Releases.
Changelogs for older releases can be found in the archive.
Version 2.0 is a major rework of the original plugin and introduces lots of new features. More details on this can be found in the Release Notes for 2.0.
Legacy version that was originally forked from the Groovy Postbuild Plugin.
This is the central pipeline step that allows users to add custom badges to their builds. A badge can either be an icon or text that can optionally be formatted as HTML rather than plain text. Users can also add links to the badges as well as styling to get the desired visual results.
See Jenkins Pipeline Steps Reference for detailed descriptions of the supported parameters.
// add a badge with an icon and text
def badge = addBadge(icon: 'symbol-rocket plugin-ionicons-api', text: 'Launching ...')
// update the icon and text during build time
badge.setIcon('symbol-planet-outline plugin-ionicons-api')
badge.setText('Lunar orbit reached, proceed landing maneuver ...')
// update the icon and text during build time
badge.setIcon('symbol-american-football-outline plugin-ionicons-api')
badge.setText('Huston, we have touchdown!')
// remove the badge
removeBadges(id: badge.getId())
// add another badge with html formatted text and css style
addBadge(text: '<i>Apollo 11 landed on the moon!</i>', style: 'color: var(--success-color)')
A convenience pipeline step that adds an info icon alongside a tooltip text and optional link.
See Jenkins Pipeline Steps Reference for detailed descriptions of the supported parameters.
// add a badge with an info icon and text
def badge = addInfoBadge(text: 'Launching in ...')
// update the text during build time
badge.setText('10 ...')
badge.setText('9 ...')
badge.setText('8 ...')
A convenience pipeline step that adds a warning icon alongside a tooltip text and optional link.
See Jenkins Pipeline Steps Reference for detailed descriptions of the supported parameters.
// add a badge with a warning icon, text and link
addWarningBadge(text: 'Houston, we have a problem ...', link: 'https://youtu.be/2Q_ZzBGPdqE')
A convenience pipeline step that adds an error icon alongside a tooltip text and optional link.
See Jenkins Pipeline Steps Reference for detailed descriptions of the supported parameters.
// add a badge with an error icon and text
addErrorBadge(text: 'Transmission failed!')
This pipeline step allows users to add custom summaries to their build overview. A summary can consist of an icon and text that can optionally be formatted as HTML rather than plain text. Users can also add links to the summary as well as styling to get the desired visual results.
See Jenkins Pipeline Steps Reference for detailed descriptions of the supported parameters.
// add a summary with an icon, text and link
addSummary(icon: 'symbol-home-outline plugin-ionicons-api', text: 'Test Chamber prepared', link: 'https://jenkins.io')
// add another summary with an icon and text
def summary = addSummary(icon: 'symbol-people-outline plugin-ionicons-api', text: 'Looking for Test Subjects ...')
// removes a summary
removeSummaries(id: summary.getId())
// add another summary with an icon and formatted html as text
addSummary(icon: 'symbol-aperture-outline plugin-ionicons-api',
text: '<b>Results:</b><li>Test Chamber ready</li><li>Test Subject missing</li>')
The Badge Plugin uses Jenkins Markup Formatter to sanitize HTML in badges and summaries. This ensures safety when using HTML for texts and prevents malicious injections.
