feat(cli): Add app diff option to specify exit code when diff #20144
+6
−3
Conversation
This file contains 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
❌ Preview Environment deleted from BunnyshellAvailable commands (reply to this comment):
|
❌ Preview Environment deleted from BunnyshellAvailable commands (reply to this comment):
|
eugene70
changed the title
eugene70
force-pushed
the
diff-exit-code
branch
from
87c02bd
to
298fa12
Compare
|
@jannfis PTAL! |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #20144 +/- ##
=======================================
Coverage 55.97% 55.97%
=======================================
Files 322 322
Lines 44546 44548 +2
=======================================
+ Hits 24933 24937 +4
- Misses 17042 17047 +5
+ Partials 2571 2564 -7 ☔ View full report in Codecov by Sentry. |
crenshaw-dev
requested changes
Sep 30, 2024
cmd/argocd/commands/app.go
Outdated
| @@ -1242,13 +1243,14 @@ func NewApplicationDiffCommand(clientOpts *argocdclient.ClientOptions) *cobra.Co | |||
| proj := getProject(c, clientOpts, ctx, app.Spec.Project) | |||
| foundDiffs := findandPrintDiff(ctx, app, proj.Project, resources, argoSettings, diffOption, ignoreNormalizerOpts) | |||
| if foundDiffs && exitCode { | |||
| os.Exit(1) | |||
| os.Exit(diffExitCode) | |||
| } | |||
| }, | |||
| } | |||
| command.Flags().BoolVar(&refresh, "refresh", false, "Refresh application data when retrieving") | |||
| command.Flags().BoolVar(&hardRefresh, "hard-refresh", false, "Refresh application data as well as target manifests cache") | |||
| command.Flags().BoolVar(&exitCode, "exit-code", true, "Return non-zero exit code when there is a diff") | |||
There was a problem hiding this comment.
Want to update this flag's description to point out that it returns non-zero when there's an error?
cmd/argocd/commands/app.go
Outdated
| } | ||
| }, | ||
| } | ||
| command.Flags().BoolVar(&refresh, "refresh", false, "Refresh application data when retrieving") | ||
| command.Flags().BoolVar(&hardRefresh, "hard-refresh", false, "Refresh application data as well as target manifests cache") | ||
| command.Flags().BoolVar(&exitCode, "exit-code", true, "Return non-zero exit code when there is a diff") | ||
| command.Flags().IntVar(&diffExitCode, "diff-exit-code", 1, "Return specified exit code when there is a diff") |
There was a problem hiding this comment.
If I recall correctly, 20 is the typical exit code for errors. Would it make sense to mention that here so that the user can pick an exit code which is unlikely to conflict with exit codes for other conditions?
eugene70
force-pushed
the
diff-exit-code
branch
from
298fa12
to
7c10f5f
Compare
The argocd app diff command returns 1 if a difference is found. In related issues, they want to return an error code that is distinguishable from common errors. However, changing the existing behavior is likely to break user's automation code. So we want to provide an explicit option(--diff-exit-code) to specify an error code. Related: argoproj#3588 Signed-off-by: Eugene Kim <[email protected]>
eugene70
force-pushed
the
diff-exit-code
branch
from
7c10f5f
to
110f45e
Compare
|
@crenshaw-dev PTAL again!! |
crenshaw-dev
approved these changes
Oct 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The argocd app diff command returns 1 if a difference is found. In related issues, they want to return an error code that is distinguishable from common errors. However, changing the existing behavior is likely to break user's automation code. So we want to provide an explicit option(--diff-exit-code) to specify an error code.
Issue: #3588