Skip to content
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

Jump to bottom

docs: Skip export keyword in notification docs #14633

Merged
merged 1 commit into from
Jul 21, 2023
Merged

docs: Skip export keyword in notification docs #14633

merged 1 commit into from
Jul 21, 2023

Conversation

lindhe
Copy link
Contributor

@lindhe lindhe commented Jul 21, 2023

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.
  3. Add a newline for clarity.

Note on DCO:

If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the Details link next to the DCO action for instructions on how to resolve this.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.

Please see Contribution FAQs if you have questions about your pull-request.

@lindhe
docs: Skip export keyword in notification docs
02c2fc2 
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>
@codecov
Copy link

codecov bot commented Jul 21, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (278237e) 49.80% compared to head (02c2fc2) 49.80%.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #14633   +/-   ##
=======================================
  Coverage   49.80%   49.80%           
=======================================
  Files         261      261           
  Lines       44838    44838           
=======================================
+ Hits        22330    22333    +3     
+ Misses      20305    20303    -2     
+ Partials     2203     2202    -1

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

crenshaw-dev
crenshaw-dev approved these changes Jul 21, 2023
View reviewed changes
Copy link
Collaborator

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not know the space prefix trick, that's awesome. Thanks, @lindhe!

@crenshaw-dev
Copy link
Collaborator

/cherry-pick release-2.8

@crenshaw-dev
Copy link
Collaborator

/cherry-pick release-2.7

@crenshaw-dev
Copy link
Collaborator

/cherry-pick release-2.6

@crenshaw-dev
Copy link
Collaborator

/cherry-pick release-2.5

@crenshaw-dev crenshaw-dev merged commit 7bade3c into argoproj:master Jul 21, 2023
24 checks passed
@gcp-cherry-pick-bot gcp-cherry-pick-bot bot mentioned this pull request Jul 21, 2023
Merged
gcp-cherry-pick-bot bot pushed a commit that referenced this pull request Jul 21, 2023
@lindhe
docs: Skip export keyword in notification docs (#14633)
2f1346a 
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>
@gcp-cherry-pick-bot gcp-cherry-pick-bot bot mentioned this pull request Jul 21, 2023
Merged
gcp-cherry-pick-bot bot pushed a commit that referenced this pull request Jul 21, 2023
@lindhe
docs: Skip export keyword in notification docs (#14633)
5ad2ff3 
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>
@gcp-cherry-pick-bot gcp-cherry-pick-bot bot mentioned this pull request Jul 21, 2023
Merged
gcp-cherry-pick-bot bot pushed a commit that referenced this pull request Jul 21, 2023
@lindhe
docs: Skip export keyword in notification docs (#14633)
dca65d0 
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>
gcp-cherry-pick-bot bot pushed a commit that referenced this pull request Jul 21, 2023
@lindhe
docs: Skip export keyword in notification docs (#14633)
4f7a034 
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>
@gcp-cherry-pick-bot gcp-cherry-pick-bot bot mentioned this pull request Jul 21, 2023
Merged
@lindhe lindhe deleted the remove-export-in-docs branch July 21, 2023 14:11
crenshaw-dev pushed a commit that referenced this pull request Jul 21, 2023
@gcp-cherry-pick-bot @lindhe
docs: Skip export keyword in notification docs (#14633) (#14645)
2fa12c8 
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>
Co-authored-by: Andreas Lindhé <lindhe@users.noreply.github.com>
crenshaw-dev pushed a commit that referenced this pull request Jul 21, 2023
@gcp-cherry-pick-bot @lindhe
docs: Skip export keyword in notification docs (#14633) (#14644)
ce87bf9 
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>
Co-authored-by: Andreas Lindhé <lindhe@users.noreply.github.com>
crenshaw-dev pushed a commit that referenced this pull request Jul 21, 2023
@gcp-cherry-pick-bot @lindhe
docs: Skip export keyword in notification docs (#14633) (#14643)
0d24330 
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>
Co-authored-by: Andreas Lindhé <lindhe@users.noreply.github.com>
crenshaw-dev pushed a commit that referenced this pull request Jul 21, 2023
@gcp-cherry-pick-bot @lindhe
docs: Skip export keyword in notification docs (#14633) (#14642)
ffe3d47 
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>
Co-authored-by: Andreas Lindhé <lindhe@users.noreply.github.com>
schakrad pushed a commit to schakrad/argo-cd that referenced this pull request Jul 24, 2023
@gcp-cherry-pick-bot @lindhe @schakrad
docs: Skip export keyword in notification docs (argoproj#14633) (ar…
7f489eb 
…goproj#14643)

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>
Co-authored-by: Andreas Lindhé <lindhe@users.noreply.github.com>
Signed-off-by: schakrad <58915923+schakrad@users.noreply.github.com>
yyzxw pushed a commit to yyzxw/argo-cd that referenced this pull request Aug 9, 2023
@lindhe
docs: Skip export keyword in notification docs (argoproj#14633)
a534db7 
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>
@suzaku suzaku mentioned this pull request Aug 15, 2023
Closed
Jneville0815 pushed a commit to radiusmethod/argo-cd that referenced this pull request Sep 30, 2023
@lindhe @Jneville0815
docs: Skip export keyword in notification docs (argoproj#14633)
8cc517a 
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>
Signed-off-by: Jimmy Neville <jimmyeneville@gmail.com>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
@lindhe @tesla59
docs: Skip export keyword in notification docs (argoproj#14633)
d8457a4 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crenshaw-dev crenshaw-dev crenshaw-dev approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@lindhe @crenshaw-dev