Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[JENKINS-38114] Consolidated help for RunWrapper.
- Loading branch information
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
src/main/resources/org/jenkinsci/plugins/workflow/support/steps/build/RunWrapper/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,16 @@ | ||
| <dl> | ||
| <dt><code>number</code></dt><dd>build number (integer)</dd> | ||
| <dt><code>result</code></dt><dd>typically <code>SUCCESS</code>, <code>UNSTABLE</code>, or <code>FAILURE</code> (<em>may</em> be null for an ongoing build)</dd> | ||
| <dt><code>displayName</code></dt><dd>normally <code>#123</code> but sometimes set to, e.g., an SCM commit identifier</dd> | ||
| <dt><code>description</code></dt><dd>additional information about the build</dd> | ||
| <dt><code>id</code></dt><dd>normally <code>number</code> as a string</dd> | ||
| <dt><code>timeInMillis</code></dt><dd>time since the epoch when the build was scheduled</dd> | ||
| <dt><code>startTimeInMillis</code></dt><dd>time since the epoch when the build started running</dd> | ||
| <dt><code>duration</code></dt><dd>duration of the build in milliseconds</dd> | ||
| <dt><code>previousBuild</code></dt><dd>another similar object, or null</dd> | ||
| <dt><code>nextBuild</code></dt><dd>similarly</dd> | ||
| <dt><code>absoluteUrl</code></dt><dd>URL of build index page</dd> | ||
| <dt><code>buildVariables</code></dt><dd>for a non-Pipeline downstream build, offers access to a map of defined build variables; for a Pipeline downstream build, any variables set globally on <code>env</code></dd> | ||
| <dt><code>changeSets</code></dt><dd>a list of <a href="http://javadoc.jenkins-ci.org/hudson/scm/ChangeLogSet.html" target="_blank">changesets</a> coming from distinct SCM checkouts; each has a <code>kind</code> and is a list of commits; each commit has a <code>commitId</code>, <code>timestamp</code>, <code>msg</code>, <code>author</code>, and <code>affectedFiles</code> each of which has an <code>editType</code> and <code>path</code>; the value will not generally be <code>Serializable</code> so you may only access it inside a method marked <code>@NonCPS</code></dd> | ||
| <dt><code>rawBuild</code></dt><dd>a <code>hudson.model.Run</code> with <a href="http://javadoc.jenkins-ci.org/hudson/model/Run.html" target="_blank">further APIs</a>, only for trusted libraries or administrator-approved scripts outside the sandbox; the value will not be <code>Serializable</code> so you may only access it inside a method marked <code>@NonCPS</code></dd> | ||
| </dl> |