Improvement: Add Examples To sh Step [JENKINS-65396] #154
Conversation
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
aHenryJard
reviewed
Apr 23, 2021
src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help-script.html
Outdated
Show resolved
Hide resolved
| <b>Escaping script content from groovy interpretation </b>> | ||
| <p>The triple-double-quote (""") string literal syntax allows for variable/expression substitution (interpolation), so the backslash (\) is interpreted as a special character "escape".</p> | ||
| <p>Since the first open parentheses is not such a special character, Groovy compilation fails. If your intent is to have literal backslashes in the resulting string, you need to escape the backslashes. That is, use a double-backslash (\\) to substitute for one literal backslash</p> | ||
| <p><code>sh (""" |
There was a problem hiding this comment.
I am not sure that we want to document scripted pipeline, any other opinions for other reviewers ? I would prefer to only have declarative pipeline in help.
There was a problem hiding this comment.
I think this might be helpful to a few people, i specifically added it because of feedback from a user.
There was a problem hiding this comment.
I think a mix of scripted and declarative is most helpful to readers, with preference to use declarative when we can
…e_task/ShellStep/help-script.html Co-authored-by: A. Jard <[email protected]>
MarkEWaite
reviewed
May 3, 2021
src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help-script.html
Outdated
Show resolved
Hide resolved
src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help-script.html
Outdated
Show resolved
Hide resolved
…e_task/ShellStep/help-script.html Co-authored-by: Mark Waite <[email protected]>
…e_task/ShellStep/help-script.html Co-authored-by: Mark Waite <[email protected]>
MarkEWaite
reviewed
May 3, 2021
src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help-script.html
Outdated
Show resolved
Hide resolved
src/main/resources/org/jenkinsci/plugins/workflow/steps/durable_task/ShellStep/help-script.html
Outdated
Show resolved
Hide resolved
Co-authored-by: Mark Waite <[email protected]>
MarkEWaite
reviewed
May 3, 2021
| ''' | ||
| </pre> | ||
| </p> | ||
| <b>Escaping script content from groovy interpolation </b>> |
There was a problem hiding this comment.
Remove extra trailing >
Suggested change
| <b>Escaping script content from groovy interpolation </b>> | |
| <b>Escaping script content from groovy interpolation </b> |
| <b>Escaping script content from groovy interpretation </b>> | ||
| <p>The triple-double-quote (""") string literal syntax allows for variable/expression substitution (interpolation), so the backslash (\) is interpreted as a special character "escape".</p> | ||
| <p>Since the first open parentheses is not such a special character, Groovy compilation fails. If your intent is to have literal backslashes in the resulting string, you need to escape the backslashes. That is, use a double-backslash (\\) to substitute for one literal backslash</p> | ||
| <p><code>sh (""" |
There was a problem hiding this comment.
I think a mix of scripted and declarative is most helpful to readers, with preference to use declarative when we can
Comment on lines
+43
to
+45
| sed "s/(AssemblyInformationalVersion\\(\\")(.*)(\\")/\\1${productVersion}\\3/g" | ||
| AssemblyInfoGlobal/AssemblyInfoGlobal.cs -r | ||
| """)</code> |
There was a problem hiding this comment.
Alternate example that shows a multi-line shell script using triple double quotes.
Suggested change
| sed "s/(AssemblyInformationalVersion\\(\\")(.*)(\\")/\\1${productVersion}\\3/g" | |
| AssemblyInfoGlobal/AssemblyInfoGlobal.cs -r | |
| """)</code> | |
| sh """ | |
| echo 'This text is single quoted' | |
| echo "This text is double quoted" | |
| echo "This text doesn't contain a double quote" | |
| echo This text doesn\\'t include an embedded double quote, it has an embedded single quote | |
| """ | |
| </code> |
Comment on lines
+40
to
+41
| <p>The triple-double-quote (""") string literal syntax allows for variable/expression substitution (interpolation), so the backslash (\) is interpreted as a special character "escape".</p> | ||
| <p>Since the first open parentheses is not such a special character, Groovy compilation fails. If your intent is to have literal backslashes in the resulting string, you need to escape the backslashes. That is, use a double-backslash (\\) to substitute for one literal backslash</p> |
There was a problem hiding this comment.
May want to use a simpler example.
Alternate example attached for you to consider.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This pull request contains example additions to the sh step. I added a few use cases in which shell script can be used in pipelines and escaped or recognized in groovy interpolation.
Issue link on Jira https://issues.jenkins.io/browse/JENKINS-65396?filter=-1
@MarkEWaite