Clarify scmGit parameter for checkout Pipeline step - #1759
Merged
Conversation
The extensions help content is included in the Pipeline steps reference extensions section at: https://www.jenkins.io/doc/pipeline/steps/params/scmgit/ The text in that location is brief and does not include screenshots. Link to the more detailed description in the plugin documentation and its related screenshots.
No need to redirect through github.com since the project now has its own page.
Experiment to see if the links will be preserved in pipeline steps reference
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify scmGit parameter for checkout Pipeline step
The documentation for the
scmGitparameter to thecheckoutstep is not as immediately accessible from the checkout page as I would like. Readers have difficulty finding that documentation in the many other documentation links within thecheckoutstep.Add more links to the
scmGitparameter documentation in hopes that readers will be more likely to find it.Change also includes other minor documentation improvements like:
Testing done
Reviewed the formatting and content of the modified documentation pages from within a running Jenkins 2.511.
Confirmed that the newly added hyperlinks reach the correct location in the internal Pipeline steps reference page at /pipeline-syntax/html/
Confirmed that the Git LFS link works as expected.
Confirmed that the modified examples of the checkout step run as expected in Jenkins 2.511 with latest Pipeline plugins.
Submitter checklist