Skip to content

Commit

Permalink
Use the snippet-generator redirect
Browse files Browse the repository at this point in the history
Allows the description of the snippet generator to move on the
jenkins.io site without requiring a change in the plugin source code.

Depends on jenkins-infra/jenkins.io#4133
  • Loading branch information
MarkEWaite committed Feb 22, 2021
1 parent a996292 commit 3180671
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The `checkout` step may be used to run any other SCM plugin, provided that it ha
It could also be used to run an SCM for which there is a special integration that lacks support for an exotic feature.
The step takes an `scm` parameter which is a map containing at least a `$class` parameter giving the full or simple class name of the desired `SCM` implementation, and the standard `poll` and `changelog` parameters.

It also takes any other parameters supported by the SCM plugin in its configuration form, using their internal names and values; use _Snippet Generator_ to get a detailed example for your SCM.
It also takes any other parameters supported by the SCM plugin in its configuration form, using their internal names and values; use [_Snippet Generator_](https://jenkins.io/redirect/pipeline-snippet-generator)to get a detailed example for your SCM.
Optional parameters can be omitted and will take their default values (to the extent supported by the SCM plugin).
For example, to run Mercurial (1.51-beta-2 or higher):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
This is a special step that will checkout using the configuration
options offered by any Pipeline-compatible SCM plugin.
Install the corresponding SCM plugin and select it from the list in the
<strong><a href="https://jenkins.io/doc/book/pipeline/getting-started/#snippet-generator">Pipeline Snippet Generator</a></strong>.
<strong><a href="https://jenkins.io/redirect/pipeline-snippet-generator">Pipeline Snippet Generator</a></strong>.
The
<strong><a href="https://jenkins.io/doc/book/pipeline/getting-started/#snippet-generator">Pipeline Snippet Generator</a></strong>
<strong><a href="https://jenkins.io/redirect/pipeline-snippet-generator">Pipeline Snippet Generator</a></strong>
uses the installed SCM plugins of your Jenkins server to suggest pipeline snippets.
</p>
<p>This step returns a <code>Map</code> of any variables the SCM plugin would
Expand Down

0 comments on commit 3180671

Please sign in to comment.