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.

Sign up for GitHub

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

add fail_on_breaking to CLI #267

Merged
merged 1 commit into from
Aug 1, 2024
Merged

add fail_on_breaking to CLI #267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/_help/continuous-integration/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,12 @@ Please check `bump deploy --help` for more usage details.

_If you want to receive automatic `bump diff` results on your Github Pull Requests you might be interested by [our Github Action](https://github.com/marketplace/actions/api-documentation-on-bump#api-diff-on-pull-requests) diff command._

Please note that by default the command will always exit with a
successful return code. If you want to use this command in a CI
environment and want the command to fail **in case of a breaking
change**, you will need to add the `--fail-on-breaking` flag to your
diff command.

#### Public API diffs

From any two API documents or URLs, you can retrieve a comprehensive changelog of what has changed between them.
Expand Down
Loading