Skip to content

Commit

Permalink
Add online help for addEmbeddableBadgeConfig Pipeline step
Browse files Browse the repository at this point in the history
Online help text is copied from the help page of the plugin.

There is much to be improved in the help page of the plugin and in the
Pipeline help.  The Pipeline help would benefit from a better example
with multiple configurations that each shows its own status.
  • Loading branch information
MarkEWaite committed Dec 25, 2023
1 parent a362ab4 commit b39f8eb
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
You can override the color using the following valid color values:

<ul>
<li>one of the values: red, brightgreen, green, yellowgreen, yellow, orange, lightgrey, blue</li>
<li>a valid hexadecimal HTML RGB color without the hashtag (e.g. FFAABB).</li>
<li>any valid <a href="https://www.december.com/html/spec/colorsvg.html">SVG color name</a></li>
</ul>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
You can override the color using the following valid color values:

<ul>
<li>one of the values: red, brightgreen, green, yellowgreen, yellow, orange, lightgrey, blue</li>
<li>a valid hexadecimal HTML RGB color without the hashtag (e.g. FFAABB).</li>
<li>any valid <a href="https://www.december.com/html/spec/colorsvg.html">SVG color name</a></li>
</ul>
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The identifier that will be assigned to this embeddable build status configuration.
The identifier is passed as the value of <code>config</code> in the embeddable build status URL parameter.
For example, if the identifier value was <code>win32build</code> then the URL parameter would be <code>config=win32build</code>.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The link that will be opened when the embeddable build status badge is clicked.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Text that describes the build status, usually the result of the build.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The text placed on the left side of the embeddable build status.
The subject is "build" by default.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<p>
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 <code>win32build</code>, that configuration can be accessed by appending <code>config=win32build</code> as one of the embeddable build status URL parameters.
</p>
<p>
Refer to the <a href="https://plugins.jenkins.io/embeddable-build-status/#plugin-content-pipeline-dsl">Embeddable build status</a> documentation for more details.
</p>

0 comments on commit b39f8eb

Please sign in to comment.