From 3180671bba7c8bcfba7e99d401b889b5cb54bdef Mon Sep 17 00:00:00 2001 From: Mark Waite Date: Mon, 22 Feb 2021 14:52:03 -0700 Subject: [PATCH] Use the snippet-generator redirect 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 https://github.com/jenkins-infra/jenkins.io/pull/4133 --- README.md | 2 +- .../plugins/workflow/steps/scm/GenericSCMStep/help.jelly | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 40ec136..ff16a0a 100644 --- a/README.md +++ b/README.md @@ -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): diff --git a/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.jelly b/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.jelly index 8d8f78c..72e56d6 100644 --- a/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.jelly +++ b/src/main/resources/org/jenkinsci/plugins/workflow/steps/scm/GenericSCMStep/help.jelly @@ -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 - Pipeline Snippet Generator. + Pipeline Snippet Generator. The - Pipeline Snippet Generator + Pipeline Snippet Generator uses the installed SCM plugins of your Jenkins server to suggest pipeline snippets.

This step returns a Map of any variables the SCM plugin would