-
Bug
-
Resolution: Unresolved
-
Minor
-
None
I'm trying to use
checkout gitSCM (some arguments here)
I see that one example, given at
https://www.jenkins.io/doc/pipeline/steps/params/scmgit/
is
checkout scmGit(userRemoteConfigs: [ [ url: 'https://github.com/jenkinsci/git-plugin' ] ])
Higher up in the page, it mentions,
" Refer to the git plugin documentation for detailed descriptions of options available to the checkout step"
But the referenced page is unusable for this sort of purpose.
I just want to find out what other things can be used in "userRemoteConfigs".
In the referenced page, I see various random examples of that used.
But nowhere do I see a concise reference of the approximate format,
"For userRemoteConfigs, here are the possible options and syntax.
url: url to the remote repo
xyz: ....
abc: ....
"
Thanks for the feedback. I agree that there is much to improve in the documentation of the git plugin.
The concise reference of the approximate format is included on the Pipeline steps page in the "Argument Descriptions". In the section labeled "userRemoteConfigs" there is a "Array / List of Nested Object" that includes the following items:
Those are the arguments of userRemoteConfigs and each can be expanded to provide more detail.
The link for the "detailed descriptions of options available to the checkout step" is using an incorrect anchor. It is using https://plugins.jenkins.io/git/#extensions when it should be using https://plugins.jenkins.io/git/#plugin-content-extensions . I'll fix that mistake in a future release.