docs: Skip export keyword in notification docs (cherry-pick #14633)#14644
Merged
crenshaw-dev merged 1 commit intorelease-2.6from Jul 21, 2023
Merged
docs: Skip export keyword in notification docs (cherry-pick #14633)#14644crenshaw-dev merged 1 commit intorelease-2.6from
export keyword in notification docs (cherry-pick #14633)#14644crenshaw-dev merged 1 commit intorelease-2.6from
Conversation
This change does three things: 1. It removes the `export` keyword. It's not required since the example executes a script where the variables are evaluated as an inline string. One could even argue that there is a slight security issue with using `export` here, since that will expose the credentials to all applications started in the current context. 2. It adds a space (` `) before the `PASSWORD` variable. This will keep it out of the user's Bash history by default. See [HISTIGNORE][bash]. 3. Add a newline for clarity. [bash]: https://www.gnu.org/software/bash/manual/bash.html#index-HISTIGNORE Signed-off-by: Andreas Lindhé <andreas@lindhe.io>
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
2 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.
Cherry-picked docs: Skip
exportkeyword in notification docs (#14633)This change does three things:
exportkeyword. It's not required since the exampleexecutes a script where the variables are evaluated as an inline
string. One could even argue that there is a slight security issue
with using
exporthere, since that will expose the credentials toall applications started in the current context.
PASSWORDvariable. This will keepit out of the user's Bash history by default. See HISTIGNORE.
Signed-off-by: Andreas Lindhé andreas@lindhe.io