Badge

The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Table of Contents

• Badge
  • addBadge: Add Badge
  • addErrorBadge: Add Error Badge
  • addHtmlBadge: Add a html badge Text
  • addInfoBadge: Add Info Badge
  • addShortText: Add Short Text
  • addWarningBadge: Add Warning Badge
  • createSummary: Print Message
  • removeBadges: Remove Badges
  • removeHtmlBadges: Remove Html Badges
  • removeSummaries: Remove Summaries

Badge

View this plugin on the Plugins Index

addBadge: Add Badge

• icon
  • Type: String
• text
  • Type: String
• id (optional)
  • Type: String
• link (optional)
  • Type: String

addErrorBadge: Add Error Badge

• text
  • Type: String
• id (optional)
  • Type: String
• link (optional)
  • Type: String

addHtmlBadge: Add a html badge Text

• html
  • Type: String
• id (optional)
  • Type: String

addInfoBadge: Add Info Badge

• text
  • Type: String
• id (optional)
  • Type: String
• link (optional)
  • Type: String

addShortText: Add Short Text

• text
  • Type: String
• background (optional)
  • Type: String
• border (optional)
  • Type: int
• borderColor (optional)
  • Type: String
• color (optional)
  • Type: String
• link (optional)
  • Type: String

addWarningBadge: Add Warning Badge

• text
  • Type: String
• id (optional)
  • Type: String
• link (optional)
  • Type: String

createSummary: Print Message

• icon
  • Type: String
• id (optional)
  • Type: String
• text (optional)
  • Type: String

removeBadges: Remove Badges

• id (optional)
  • Type: String

removeHtmlBadges: Remove Html Badges

• id (optional)
  • Type: String

removeSummaries: Remove Summaries

• id (optional)
  • Type: String

https://jenkins.io/doc/pipeline/steps/badge/