Skip to content

Commit

Permalink
Update BREAKING-CHANGES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Reuven Harrison authored Nov 12, 2023
1 parent 480414d commit c36bcf8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion BREAKING-CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ oasdiff checks --severity warn,error
A common way to use oasdiff is by running it as a step the CI/CD pipeline to detect breaking changes.
In order to prevent breaking changes, oasdiff can be configured to return an error if any breaking change is found:
- To exit with return code 1 when any ERR-level breaking changes are found, add the `--fail-on ERR` flag.
- To exit with return code 1 even if only WARN-level breaking changes are found, add the `--fail-on WARN` flag.
- To exit with return code 1 when any breaking changes are found, WARN-level or ERR-level, add the `--fail-on WARN` flag.

### Output Formats
By default, breaking changes are displayed as human-readable text.
Expand Down

0 comments on commit c36bcf8

Please sign in to comment.