Releases: bump-sh/cli
v2.8.2 (2024-08-05) Overlays fix
Some dependency npm package upgrade and a fix in the new bump overlay
command.
🐛 Allow overlay to apply to a list of targets
The release fixes a bug in the newly introduced bump overlay
command to allow overlay actions targeting a list of elements, so the action is applied to ALL targets (instead of only the first one before this release).
Have fun designing APIs 😊 ✨
v2.8.1 (2024-04-25) Upgrades and a small fix
On top of some dependency npm package upgrades (to remove the nasty security audit warnings) this release fixes a small bug.
🐛 Allow overlay target to be the root document
The release fixes a bug in the newly introduced bump overlay
command to allow overlay actions targeting the root of the document ($
in JSON path).
This should help for the kind of use-case where you want to add topics to your API document, e.g.:
overlay: 1.0.0
info:
title: Adding topics to my API
version: 0.0.1
actions:
- target: "$"
update:
x-topics:
- title: Getting started
content: |
This paragraph is added via an overlay because my **tech
writers** team is different from my **developers** team
and I want to publish introduction topics in our API
documentation!
Have fun designing APIs 😊 ✨
v2.8.0 (2024-03-19) Add new `overlay` command
🆕 (BETA) Add a new overlay
command to apply OpenAPI overlays to an existing API document
This release adds a new command to the cli: bump overlay
to apply OpenAPI overlays to an input API document. Usage is as simple as it gets. As the functionality is still pretty new (the Overlay specification has yet some questions to answer) consider this new command as a beta feature. Overlay behaviors might change in the future.
bump overlay api-document.yaml overlay-file.yaml > api-overlayed-document.yaml
The command will output a new generated API document with the overlay applied.
Note: you can also apply the overlay during the bump deploy
command with the new --overlay
flag:
bump deploy api-document.yaml --doc my-doc --token my-token --overlay overlay-file.yaml
v2.7.2 (2023-10-02) Minor fixes
This is a tiny release without noticeable change but some fixes:
- Fix an error message which was suggesting a wrong option
- Fix node dependencies when the repo is used as a library
v2.7.1 (2023-09-19) Fix a bug for deployments from a URL
🐛 Bugfix release
This release fixes a bug introduced in v2.7.0 which wouldn't allow the usage of the bump deploy
command followed by a URL. Only files would be accepted as an argument.
Now, bump deploy --doc bump https://developers.bump.sh/source.json
works as expected.
v2.7.0 (2023-06-13) Deploy multiple documentation files to a hub all at once
TL;DR
- 🆕
deploy
multiple files at once on your Hub withbump deploy --hub my-hub DIRECTORY
- 🧹 Minor improvements
- 🆙 Internal refactoring & upgrades
Detailed changlog
deploy
multiple files at once on your Hub
You can now provide a directory path instead of being limited to a single file path only.
Use the deploy
command to easily target a hub: bump deploy --hub my-hub DIRECTORY
.
It will allow you to deploy all the files within the specified directory to your desired my-hub
hub on Bump.sh.
Want to select a list of files based on your file naming convention?
Use the --filename-pattern <pattern>
flag. This pattern can include *
wildcard special character, {slug}
a filter which will extract your documentation slug from the filename, and any other fixed characters. A picture is worth a thousand words:
Here is an example where you would want to deploy the whole my/directory/
directory to your my-hub
Hub with the following command.
bump deploy my/directory/ --hub my-hub --filename-pattern *-api-{slug}-service
Where the directory holds those files:
my/dir/
└─ private-api-users-service.yml
└─ partner-api-payments-service.yml
└─ public-api-contracts-service.yml
All of the three files shown above will be deployed to your Bump.sh Hub with users
, payments
and contracts
being the respective documentation slugs.
Minor improvements
- The live preview feature (
bump preview --live my-definition-api.yml
) will create a first preview straight away without waiting for a first change on the target file. - The CLI will warn you if you run an out-dated version. No excuses to keep some old dangling versions on your machine 🙂
Internals & upgrades
- We’ve refactored the deployment related code quite a bit to receive the new “Multiple files deploy” feature.
- Upgrade to TypeScript 4.5
- Some dependencies upgrades thanks to dependabot
Have fun designing APIs 😊 ✨
v2.6.0 (2023-04-21) Add a parameter to fail diff command on breaking changes
🆕 diff
command accepts a new --fail-on-breaking
argument
- When using the
bump diff
command you can now pass the--fail-on-breaking
argument in order for the command to return an error code if the diff contains a breaking change. This is especially useful in a CI environment when diff is computed for each pull request. Note: this argument is enabled by default if the environment variableCI=true
is set.
🆙 Partial support for the latest 2.6 release of AsyncAPI specification
- AsyncAPI recently release their 2.6 version. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.6.0
With this new release of the Bump CLI we partially support the latest changes of the AsyncAPI spec.
Have fun designing APIs 😊 ✨
v2.5.0 (2023-01-11) Add an expiration option for public diffs & support for AsyncAPI 2.5.0
🆕 diff
command accepts a new --expire
argument
- When using the
bump diff
command without authentication (without--token
and--doc
arguments) you can now provide a custom expiration date (defaults to 1 day). E.g.bump diff --expires '2023-03-01' file-openapi-1.yml file-openapi-2.yml
to create a public diff which will expire on the 1st of March 2023. You can also provide the keyword--expires never
for your generated public diff to never expire.
🆙 Partial support for the latest 2.5 release of AsyncAPI specification
-
AsyncAPI recently release their 2.5 version. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.5.0
With this new release of the Bump CLI we partially support the latest changes of the AsyncAPI spec. -
Thanks to @dependabot, all the node dependencies we use are up-to-date as of today.
Continue to have fun designing APIs 😊 ✨
v2.4.1 (2022-10-14) Fixing a bug for Windows
🐛 Bugfix release for windows CLI execution
This is a minor release to fix a bug in filesystem external references on Windows machines. Cf #360
v2.4.0 (2022-05-19) Branch deployments & support for AsyncAPI 2.4
🆕 diff
and deploy
commands accepts a new --branch
argument
-
Both the
diff
&deploy
commands will now accept a--branch
argument so you can deploy new versions of your API reference in a separate branch. By default, when you don't use the argument all new versions are deployed to a default main branch.This new feature is useful when you want to keep multiple history available on your API documentation. For example, you might want to deploy all your newest API changes on a
latest
branch (with the new--branch latest
argument), and when happy about the latest changes, you decide to release to the main default branch (by removing the--branch ...
argument).
🆙 Support for the latest 2.4 release of AsyncAPI specification
-
AsyncAPI recently release their 2.4 version. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.4.0
With this new release of the Bump CLI we partially support the latest changes of the AsyncAPI spec. -
Thanks to @dependabot, all the node dependencies we use are up-to-date as of today.
Have fun designing APIs and our new branching mechanism 🌳 ✨