Skip to content

Commit d046b12

Browse files
committed
Add snippet generator link to help page
Users frequently comment in the feedback on the jenkins.io checkout page https://www.jenkins.io/doc/pipeline/steps/workflow-scm-step/ that they would like more examples. Many of those writing the comments may not be aware that the Pipeline Snippet Generator can provide help from within their Jenkins server for the specific plugins and plugin versions they are using. Hyperlink to the Pipeline Snippet Generator in hopes that users will see one of the hyperlinks and understand that they can use their own Jenkins server for better information about the Pipeline Syntax.
1 parent 4de73bf commit d046b12

File tree

1 file changed

+6
-4
lines changed
  • src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep

1 file changed

+6
-4
lines changed

src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.jelly

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
<?jelly escape-by-default='true'?>
33
<div xmlns:j="jelly:core" xmlns:st="jelly:stapler">
44
<p>
5-
This is a special step that allows to run checkouts using any configuration
5+
This is a special step that will checkout using the configuration
66
options offered by any Pipeline-compatible SCM plugin.
7-
To use a concrete SCM implementations, just install the corresponding plugin
8-
and check if it is shown in the list below.
9-
Then select the SCM to use from the dropdown list and configure it as needed.
7+
Install the corresponding SCM plugin and select it from the list in the
8+
<strong><a href="https://jenkins.io/doc/book/pipeline/getting-started/#snippet-generator">Pipeline Snippet Generator</a?</strong>.
9+
The
10+
<strong><a href="https://jenkins.io/doc/book/pipeline/getting-started/#snippet-generator">Pipeline Snippet Generator</a?</strong>
11+
uses the installed SCM plugins of your Jenkins server to suggest pipeline snippets.
1012
</p>
1113
<p>This step returns a <code>Map</code> of any variables the SCM plugin would
1214
set in a Freestyle job, so if your SCM is git, you can do:

0 commit comments

Comments
 (0)