jenkins-plugin-cli --plugins badge:2.6
jenkins-plugin-cli --plugins badge:2.5
jenkins-plugin-cli --plugins badge:2.4
jenkins-plugin-cli --plugins badge:2.3
jenkins-plugin-cli --plugins badge:2.2
jenkins-plugin-cli --plugins badge:2.1
The Badge Plugin has been completely reworked to overcome some limitations and bugs of previous versions and in order to be easier to maintain.
This release is expected to not cause incompatibilities with existing pipeline definitions and configuration on a technical level but may introduce some (minor) visual changes to existing badges and summaries. See the following secions as well as #151 and the README for more details.
In case you find a bug or potential incompatibility that may have slipped the extensive testing please do not hesitate to create a new issue.
The new new major version 2.0 is marked as be incompatible with previous versions and deprecates most of the previous pipeline steps and fields for these steps.
As of now the following plugins are incompatible with Badge Plugin 2.x:
264.vf6e02a_77d5b_c
as compatible release1.14-925.v95b_9089a_4c7f
as compatible realeaseUsers of these plugins are advised to upgrade the Badge Plugin alongside compatible releases of the respective plugin.
JCasC
but also may impact some visualization, see next pointsJenkins.get().getMarkupFormatter().translate()
MarkupFormatter
for it)As of now there are multiple MarkupFormatter implementation available. The default that is shipped with Jenkins is Plain Text
that will not render any HTML or any other markup languages.
In case you find that your badges or summaries created by the Badge Plugin are no longer rendering HTML in their texts, it is likely caused by the configured MarkupFormatter being Plain Text
.
To render HTML in badges and summaries you will need to change the global Jenkins Configuration to use Safe HTML
provided via OWASP Markup Formatter.
See the README for details.
Since the global plugin configuration got removed, the JCasC directives such as
jenkins:
security:
badgePlugin:
disableFormatHTML: false
are no longer valid and should be removed or better replaced by configuring Jenkins global MarkupFormatter
jenkins:
markupFormatter:
rawHtml:
disableSyntaxHighlighting: true
At this point it is not clear when or if these deprecations will be removed, however use is discouraged and there are no plans to maintain deprecated functionallity.
addHtmlBadge
(can be substituted by addBadge
)
addShortText
(can be substituted by addBadge
)
createSummary
(can be substituted by addSummary
)
addBadge
reworkedtext
can be plain text or HTML (with Safe HTML
MarkupFormatter enabled)addInfoBadge
, addWarningBadge
, addErrorBadge
reworkedaddBadge
addSummary
createSummary
and has all feature the other badges havedef badge = addBadge(icon: 'everything-is-awesome.png', text: 'All is good!')
...
badge.setText('Somehing bad happened!')
badge.setIcon('everything-is-on-fire.png')
jenkins-plugin-cli --plugins badge:2.0
jenkins-plugin-cli --plugins badge:1.13
jenkins-plugin-cli --plugins badge:1.12
unclassified
section to the security
section (#150) @strangelookingnerdjenkins-plugin-cli --plugins badge:1.11
jenkins-plugin-cli --plugins badge:1.10
jenkins-plugin-cli --plugins badge:1.9.1
jenkins-plugin-cli --plugins badge:1.9
jenkins-plugin-cli --plugins badge:1.8
jenkins-plugin-cli --plugins badge:1.7
jenkins-plugin-cli --plugins badge:1.6
jenkins-plugin-cli --plugins badge:1.5
jenkins-plugin-cli --plugins badge:1.4
jenkins-plugin-cli --plugins badge:1.3
jenkins-plugin-cli --plugins badge:1.2
jenkins-plugin-cli --plugins badge:1.1
jenkins-plugin-cli --plugins badge:1.0