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.

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

docs: use pipefail option in shell commands to prevent accidental deletions #597

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jacksgt
Copy link

@jacksgt jacksgt commented Jan 12, 2024

Description

When using a pipe in shell commands (|) it is critical that the pipefail option is used, otherwise the second command in the pipeline silently overwrites any errors from the first command.
Argo CD will then treat the stdout output as valid (even if it is empty), which can have catastrophic effects: deleting all resources belonging to the Application/ApplicationSet.

Several users have already been hit by this: #533

Therefore I believe it is very important that the correct commands are shown in the documentation.

Fixes: #533

Checklist

Please make sure that your PR fulfills the following requirements:

  • Reviewed the guidelines for contributing to this repository
  • The commit message follows the Conventional Commits Guidelines.
  • Tests for the changes have been updated
  • Are you adding dependencies? If so, please run go mod tidy -compat=1.21 to ensure only the minimum is pulled in.
  • Docs have been added / updated
  • Optional. My organization is added to USERS.md.

Type of Change

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • New tests
  • Build/CI related changes
  • Documentation content changes
  • Other (please describe)

docs/usage.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants