v2.9.2 (2025-01-20) New flag on `deploy` and `diff` commands

🆕 Multiple --overlay flags are now supported on the bump deploy command

You can now pass the --overlay overlay-file.yml flag multiple times to the bump deploy command. Meaning you can apply as many different overlay files on your original API definition before publishing your documentation on Bump.sh.

The order of the flags is important as overlays will be applied sequencially one after another.

Usage:

> bump deploy \
    --doc my-doc --token my-secret-token \
    --overlay overlay-translate-to-english.yml --overlay overlay-remove-wip-endpoints.yml 
    openapi-definition.yml

Result:
The file openapi-definition.yml will be overlayed first by the overlay-translate-to-english.yml file, then by the overlay-remove-wip-endpoints.yml and finally be published to the my-doc documentation on Bump.sh.

If you missed the overlay feature of the CLI, head to this guide we wrote to explain the rational behind overlays

🆕 The bump diff command accepts a new --no-fail-on-breaking flag

In the context of CI (Continuous Integration) environments, the CLI make the --fail-on-breaking flag default to true on the bump diff. This is detected by the CI=1 environment variable that is usually set by all CI tools.

We now introduced a new --no-fail-on-breaking flag which allows a user to disable this feature in a CI environment.

Usage:

> bump diff --no-fail-on-breaking openapi-v1.yml openapi-v2.yml

Result:
If the comparison of both API definitions leads to a breaking change, the command will exit with a 0 status code and will NOT make the build fail.

🐛 Two small fixes

• Fix on the overlay feature: when applying an overlay on a YAML input file, both the YAML comments and the line width of the original file will be preserved. Thanks a lot @thim81 for your contribution!
• Fix on the exported core Diff class when using the package as a node dependency. The interface of the class was broken in 2.9.0, it's now fixed and possible to use the class programmatically.

Upgrades

As usual, the release is packed with dependency updates to make the CLI stable & secure.

---

Have fun designing APIs 😊 ✨