Skip to content

Highlight importance of using single-quotes. #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 14, 2020
Merged

Highlight importance of using single-quotes. #110

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c53f11
Highlight importance of using single-quotes.
jeffret-b Sep 28, 2020
9abc42b
Add step names.
jeffret-b Sep 29, 2020
5512d5e
Apply suggestions from code review
jeffret-b Oct 14, 2020
849ce76
Remove note from BindingStep help.
jeffret-b Oct 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ withCredentials([usernamePassword(credentialsId: 'amazon', usernameVariable: 'US
}
```

#### Note

You should use a single quote (') instead of a double quote (") whenever you can.
This is particularly important in Pipelines where a statement may be interpreted by both the Pipeline engine and an external interpreter, such as a Unix shell (`sh`) or Windows Command (`bat`) or Powershell (`ps`).
This reduces complications with password masking and command processing.
The first step in the above example properly demonstrates this.
The next two steps use the basic Pipeline "echo" step.
The first one references the Groovy variable and needs no quotes.
The second one needs to use double quotes, so that the interpolation is performed in Groovy.

For more information, see the Pipeline step reference for [Credentials Binding Plugin](https://www.jenkins.io/doc/pipeline/steps/credentials-binding/).

## Changelog

See [GitHub Releases](https://github.com/jenkinsci/credentials-binding-plugin/releases) for new releases,
Expand Down
5 changes: 5 additions & 0 deletions src/main/resources/org/jenkinsci/plugins/credentialsbinding/impl/BindingStep/help.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,8 @@
<a href="https://jenkins.io/blog/2019/02/21/credentials-masking/" target="_blank">Limitations of Credentials Masking</a>
blog post for more background.
</p>
<h4>Note</h4>
<p>
You should use a single quote (') instead of a double quote (") whenever you can.
This reduces complications with password masking and command processing.
</p>