chore: Document return behavior of cdk diff #1446
Merged
Conversation
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
The `cdk diff` command intentionally returns non-zero when a difference is found, similar to how the POSIX `diff` command behaves (returning 0 when no difference is found, 1 when some difference is found, and >1 when an error occurred). This behavior was however undocumented, possibly leading to user confusion. This change adds a note in `cdk --help` that mentions the exit code 1 will be used when a difference is found.
rix0rrr
approved these changes
Dec 28, 2018
| .command('destroy [STACKS..]', 'Destroy the stack(s) named STACKS', yargs => yargs | ||
| .option('force', { type: 'boolean', alias: 'f', desc: 'Do not ask for confirmation before destroying the stacks' })) | ||
| .command('diff [STACK]', 'Compares the specified stack with the deployed stack or a local template file', yargs => yargs | ||
| .command('diff [STACK]', 'Compares the specified stack with the deployed stack or a local template file, and returns with status 1 if any difference is found', yargs => yargs |
There was a problem hiding this comment.
Maybe just say nonzero? That gives us some leeway to use exit codes for different cases?
There was a problem hiding this comment.
I want to specifically mirror the behavior of the POSIX diff, which is to return 1 if a difference is found, 0 if no difference is found, and some other value if an error occurred. It might actually be useful for users to be able to differentiate "failed" from "diff found", which justifies the strictness of the return code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The
cdk diffcommand intentionally returns non-zero when a difference is found,similar to how the POSIX
diffcommand behaves (returning 0 when no difference isfound, 1 when some difference is found, and >1 when an error occurred). This
behavior was however undocumented, possibly leading to user confusion.
This change adds a note in
cdk --helpthat mentions the exit code 1 will be usedwhen a difference is found.
Fixes #1440
Pull Request Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.