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.

Embeddable Build Status Plugin

View this plugin on the Plugins site

addEmbeddableBadgeConfiguration: Add an Embeddable Badge Configuration

Additional embeddable build status configurations can be created for a Jenkins Pipeline. Those embeddable build status configurations can be displayed in the same locations as the default embeddable build status configuration. For example, if a Pipeline defined a build status configuration named win32build, that configuration can be accessed by appending config=win32build as one of the embeddable build status URL parameters.

Refer to the Embeddable build status documentation for more details.

  • id : String
    The identifier that will be assigned to this embeddable build status configuration. The identifier is passed as the value of config in the embeddable build status URL parameter. For example, if the identifier value was win32build then the URL parameter would be config=win32build.
  • animatedOverlayColor : String (optional)
    You can override the color using the following valid color values:
    • one of the values: red, brightgreen, green, yellowgreen, yellow, orange, lightgrey, blue
    • a valid hexadecimal HTML RGB color without the hashtag (e.g. FFAABB).
    • any valid SVG color name
  • color : String (optional)
    You can override the color using the following valid color values:
    • one of the values: red, brightgreen, green, yellowgreen, yellow, orange, lightgrey, blue
    • a valid hexadecimal HTML RGB color without the hashtag (e.g. FFAABB).
    • any valid SVG color name
  • link : String (optional)
    The link that will be opened when the embeddable build status badge is clicked.
  • status : String (optional)
    Text that describes the build status, usually the result of the build.
  • subject : String (optional)
    The text placed on the left side of the embeddable build status. The subject is "build" by default.

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.