-
Notifications
You must be signed in to change notification settings - Fork 105
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.
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
Conversation
Increaed the documented visibility of the recommendation to use single quotes whenever possible.
@Wadeck, does this look like what you want? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have agreed to add a link to an article with details about password masking that could be broken depending on the content of the variables due to double quotes. This article is not yet written / up-to-date.
So this PR without the expected links (in both readme and help) has low value as there is no explanation about why ("complications" is not enough in this particularly difficult topic).
Do you expect the article to be a new one or a rewamp of an existing one?
src/main/resources/org/jenkinsci/plugins/credentialsbinding/impl/BindingStep/help.html
Outdated
Show resolved
Hide resolved
I expect it to be a new one. There really isn't an existing one that it makes sense to revamp. We could make that new document a blog post -- that format would make it easier to get something out more quickly, even if it's later followed up by more polished documentation. |
Co-authored-by: Wadeck Follonier <[email protected]>
src/main/resources/org/jenkinsci/plugins/credentialsbinding/impl/BindingStep/help.html
Outdated
Show resolved
Hide resolved
Feedback provided in https://cloudbees.atlassian.net/browse/JENSEC-1069 (CloudBees internal ticket) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
jenkinsci/workflow-cps-plugin#370 by @car-roll will probably help more.
src/main/resources/org/jenkinsci/plugins/credentialsbinding/impl/BindingStep/help.html
Outdated
Show resolved
Hide resolved
src/main/resources/org/jenkinsci/plugins/credentialsbinding/impl/BindingStep/help.html
Outdated
Show resolved
Hide resolved
Yes, I agree with that. |
Co-authored-by: Jesse Glick <[email protected]>
As it is already covered, as mentioned in Jesse's comment.
I updated this per Jesse's review comments, but it still needs coordination with other changes. It should be considered on hold for now. |
Increase the documented visibility of the recommendation to use single quotes whenever possible.