Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Merge pull request #211 from amuniz/JENKINS-30086
[JENKINS-30086] Steps help and description clean up Originally-Committed-As: 71a89610d8ce4597fc2a95705301820d15c76501
- Loading branch information
Showing
6 changed files
with
50 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help-path.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
<p> | ||
Current directory (<code>pwd()</code>) relative path to the Groovy file to load. | ||
</p> |
17 changes: 17 additions & 0 deletions
17
cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/LoadStep/help.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<div> | ||
Takes a filename in the workspace and runs it as Groovy source text. | ||
<p> | ||
The loaded file can contain statements at top level or just load and run a closure. For example: | ||
</p> | ||
<pre> | ||
def flow | ||
node('slave') { | ||
flow = load 'flow.groovy' | ||
flow.functionA() | ||
} | ||
flow.functionB() | ||
</pre> | ||
<p> | ||
Where <code>flow.groovy</code> defines functionA and functionB functions (among others) before ending with <code>return this;</code> | ||
<p> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
cps/src/main/resources/org/jenkinsci/plugins/workflow/cps/steps/ParallelStep/help.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
<div> | ||
<p> | ||
Takes a map from branch names to closures and an optional argument <code>failFast</code> | ||
which will terminate all branches upon a failure in any other branch: | ||
</p> | ||
<pre> | ||
parallel firstBranch: { | ||
// do something | ||
}, secondBranch: { | ||
// do something else | ||
}, | ||
failFast: true|false | ||
</pre> | ||
</div> |