Skip to content

Commit 4a95479

Browse files
authored
Add online help for addEmbeddableBadgeConfig Pipeline step (#279)
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.
1 parent a362ab4 commit 4a95479

File tree

7 files changed

+29
-0
lines changed

7 files changed

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

0 commit comments

Comments
 (0)