Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add online help for addEmbeddableBadgeConfig Pipeline step #279

Merged
merged 1 commit into from
Dec 25, 2023
Merged

Add online help for addEmbeddableBadgeConfig Pipeline step #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ...g/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-animatedOverlayColor.html
View file
Open in desktop
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>
7 changes: 7 additions & 0 deletions ...in/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-color.html
View file
Open in desktop
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>
3 changes: 3 additions & 0 deletions src/main/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-id.html
View file
Open in desktop
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>.
1 change: 1 addition & 0 deletions ...ain/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-link.html
View file
Open in desktop
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.
1 change: 1 addition & 0 deletions ...n/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-status.html
View file
Open in desktop
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.
2 changes: 2 additions & 0 deletions .../resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help-subject.html
View file
Open in desktop
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.
8 changes: 8 additions & 0 deletions src/main/resources/org/jenkinsci/plugins/badge/dsl/AddEmbeddableBadgeConfigStep/help.html
View file
Open in desktop
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>