Badge

ID: badge
Warning IconThis plugin is up for adoption! We are looking for new maintainers. Visit our Adopt a Plugin initiative for more information.

Jenkins plugin to add badges and build summary entries from a pipeline.

This plugin was forked from the Groovy Postbuild Plugin which will in future use the API from this plugin.

addBadge

This method allows to add build badge icons.

alt text

// puts a badge with the given icon and text.

// addBadge
// ------------------------------------------

/**
 * minimal params
 * 
 * icon: The icon for this badge
 * text: The text for this badge
 */
addBadge(icon: <icon>, text: <text>)

/**
 * all params
 * 
 * icon: The icon for this badge
 * text: The text for this badge
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 * link: (optional) The link to be added to this badge
 */
addBadge(icon: <icon>, text: <text>, id: <id>, link: <link>)


// addInfoBadge
// ------------------------------------------

/**
 * minimal params
 * 
 * text: The info text for this badge
 */
addInfoBadge(text: <text>)

/**
 * all params
 * 
 * text: The info text for this badge
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 * link: (optional) The link to be added to this badge
 */
addInfoBadge(text: <text>, id: <id>, link: <link>)


// addWarningBadge
// ------------------------------------------

/**
 * minimal params
 * 
 * text: The text for this warning badge
 */
addWarningBadge(text: <text>)

/**
 * all params
 * 
 * text: The text for this warning badge
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 * link: (optional) The link to be added to this badge
 */
addWarningBadge(text: <text>, id: <id>, link: <link>)


// addErrorBadge
// ------------------------------------------

/**
 * minimal params
 * 
 * text: The text for this error badge
 */
addErrorBadge(text: <text>)

/**
 * all params
 * 
 * text: The text for this error badge
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 * link: (optional) The link to be added to this badge
 */
addErrorBadge(text: <text>, id: <id>, link: <link>)

removeBadges

Removes badges

// removes badges. If no id is provided all are removed, otherwise only the badges with a matching id
// removeBadges
// ------------------------------------------

/**
 * minimal params
 * 
 */
removeBadges()

/**
 * all params
 * 
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 */
removeBadges(id: <id>)

addHtmlBadge

Puts a badge with custom html

// puts a badge with a custom html content.
// addHtmlBadge
// ------------------------------------------

/**
 * minimal params
 * 
 * html: The html content to be used for this badge
 */
addHtmlBadge(html: <html>)

/**
 * all params
 * 
 * html: The html content to be used for this badge
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 */
addHtmlBadge(html: <html>, id: <id>)

removeHtmlBadges

Removes html badges

// removes html badges. If no id is provided all are removed, otherwise only the badges with a matching id
// removeHtmlBadges
// ------------------------------------------

/**
 * minimal params
 * 
 */
removeHtmlBadges()

/**
 * all params
 * 
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 */
removeHtmlBadges(id: <id>)

addShortText

Puts a badge with a short text

// puts a badge with a short text, using the default format.
// For Colors supported, Google "html color names".

// addShortText
// ------------------------------------------

/**
 * minimal params
 * 
 * text: The text to add fot this badge
 */
addShortText(text: <text>)

/**
 * all params
 * 
 * text: The text to add fot this badge
 * background: (optional) The background-color for this short text
 * border: (optional) The border width for this short text
 * borderColor: (optional) The order color for this short text
 * color: (optional) The color for this short text
 * link: (optional) The link for this short text
 */
addShortText(text: <text>, background: <background>, border: <border>, borderColor: <borderColor>, color: <color>, link: <link>)

createSummary

Puts a badge with a short text

alt text

// creates an entry in the build summary page and returns a summary object corresponding to this entry. The icon must be one of the 48x48 icons offered

// createSummary
// ------------------------------------------

/**
 * minimal params
 * 
 * icon: The icon for this summary
 */
createSummary(icon: <icon>)

/**
 * all params
 * 
 * icon: The icon for this summary
 * id: (optional) The id for this badge. This id can be used to selectively delete badges.
 * text: (optional) The title text for this summary
 */
createSummary(icon: <icon>, id: <id>, text: <text>)


def summary = createSummary(icon)
summary.appendText(text, escapeHtml)
summary.appendText(text, escapeHtml, bold, italic, color)

icons

In addition to the default 16x16 icons offered by Jenkins, badge plugin provides the following icons:

  • alt text completed.gif
  • alt text db_in.gif
  • alt text db_out.gif
  • alt text delete.gif
  • alt text error.gif
  • alt text folder.gif
  • alt text green.gif
  • alt text info.gif
  • alt text red.gif
  • alt text save.gif
  • alt text success.gif
  • alt text text.gif
  • alt text warning.gif
  • alt text yellow.gif

other plugin icons

Other plugin icons can be used by setting the path of the icon within the jenkins context. Don't forget the leading '/'.

addBadge(icon: "/static/8361d0d6/images/16x16/help.png", text: "help")

Allow HTML in Badge and Summary

The badge plugin uses by default the OWASP Markup Formatter to sanitize the HTML Badge and Summary. This feature can be disabled in the Jenkins configuration: Manage Jenkins -> Configure System -> Badge Plugin

alt text