Skip to content

Commit a799531

Browse files
authored
chore(core): Explain usage of '--fail' in 'cdk diff' (#25638)
Explain usage of '--fail' in 'cdk diff'. See https://stackoverflow.com/questions/69574034/what-are-the-returned-status-code-of-cdk-diff ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent f05ed21 commit a799531

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/aws-cdk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ See the [CDK reference documentation](https://docs.aws.amazon.com/cdk/api/latest
146146
### `cdk diff`
147147

148148
Computes differences between the infrastructure specified in the current state of the CDK app and the currently
149-
deployed application (or a user-specified CloudFormation template). This command returns non-zero if any differences are
150-
found.
149+
deployed application (or a user-specified CloudFormation template). If you need the command to return a non-zero if any differences are
150+
found you need to use the `--fail` command line option.
151151

152152
```console
153153
$ # Diff against the currently deployed stack

0 commit comments

Comments
 (0)