Embeddable Build Status Icon
Jenkins exposes the current status of your build as an image in a fixed URL. You can put this URL into other sites (such as GitHub README) so that people can see the current state of the build.
For each variant there are two URLs available for inclusion:
- protected exposes the badge to users having at least Read permission on the job
- unprotected exposes the badge to users having at least ViewStatus permission on the job
Note
If you are using Multibranch Pipelines the branch within the job path or name needs to be URL encoded twice.Example:
?job=path/to/job/branch/path
would become
?job=path%2Fto%2Fjob%2Fbranch%252Fpath
See examples below!
Configuration
Please read the documentation to configure and customize your badge.Examples
(Hover badge to see custom configuration)flat
flat-square
plastic
ball-size
Links
Plain link
Protected
https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon
Unprotected
https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689
Markdown
Protected
[![Build Status](https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon)](https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/)
Unprotected
[![Build Status](https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689)](https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/)
HTML
Protected
<a href='https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/'><img src='https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon'></a>
Unprotected
<a href='https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/'><img src='https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689'></a>
Asciidoc
Protected
image:https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon[link='https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/']
Unprotected
image:https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689)[link='https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/']
Confluence
Protected
[!https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon!|https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/]
Unprotected
[!https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689!|https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/]
XWiki
Protected
[[image:https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon>>https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/||target='__new']]
Unprotected
[[image:https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689>>https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/||target='__new']]
RDoc
Protected
{<img src='https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon'/>}[https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/]
Unprotected
{<img src='https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689'/>}[https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/]
Textile
Protected
"!https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon!":https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/
Unprotected
"!https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689!":https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/
Bitbucket
Protected
[Build Status](https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/icon "https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/")
Unprotected
[Build Status](https://dvs1.progwml6.com/jenkins/buildStatus/icon?job=TConstruct_1.8.9&build=689 "https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/")
Embeddable Build Status Text
Jenkins also exposes the current status of your build in plain text. You can use this in external scripts for easier interpretation of the current state of the build. Similar to the badge there are both protected, as well as unprotected variants.
Text Only
Protected
https://dvs1.progwml6.com/jenkins/user/parker8283/my-views/view/All/job/TConstruct_1.8.9/689/badge/text
Unprotected
https://dvs1.progwml6.com/jenkins/buildStatus/text?job=TConstruct_1.8.9&build=689