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 🌳 ✨

v2.3.3 (2022-02-03) Support for AsyncAPI 2.3

🆙 Support for the latest 2.3 release of AsyncAPI specification

• AsyncAPI recently release their 2.3 version. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.3.0
  With this new release of the Bump CLI we support the latest changes of the AsyncAPI spec.

Have fun designing APIs ✨

v2.3.2 (2022-01-20) Allow public `bump diff` command

🆕 diff command can now be called unauthenticated

• The bump diff command can be called without the --doc (and token) flags so you can now diff any two OpenAPI or AsyncAPI definitions

v2.3.1 (2022-01-12) Add new format outputs for the `bump diff` command

🆕 diff command now accepts a --format argument

• The bump diff command now accepts a --format argument to be able to return three different format diff outputs:
  • text will return the current default format
  • markdown will return a markdown formatted diff
  • json will return a list of json objects with all the details of the diff

v2.3.0 (2022-01-12) Internal changes to export core diff library

🔧 Internal changes only

• This release is mainly a refactoring to avoid using the commands/diff.ts Diff command class to be able to programmatically retrieve the diff result. Instead of calling bump.Diff.run([cli, params]) you'll now have to instantiate the lib and use the exported run function like so: new bump.Diff(config).run. See the run function signature for details.

🆙 Upgrades

Thanks to @dependabot, all the node dependencies we use are up-to-date as of today.

v2.2.6 (2021-10-18) bugfix release 🐛

🐛 bugfix

• Handle empty diffs properly when two files are given as input to the bump diff command. See #172 for details

v2.2.5 (2021-10-12) Accept AsyncAPI files up to v2.2.0 of the specificiation

🆕 Improved AsyncAPI support

• The CLI now accepts AsyncAPI files in version 2.1 (released in june 2021) & version 2.2 (released in septembre 2021)

v2.2.4 (2021-10-08) Internal changes to fix programmatic usage of the CLI

🐛 🔧 Internal changes only

• fixes a bug introduced by previous release to be able to use this package programmatically (currently used by our Github-Action)

v2.2.3 (2021-10-06) 'bump diff' can now compare two files

🆕 Compute changelog between two versions of your API

• This release brings a new possibility to the existing bump diff command which was released in v2.1.0.

  You can now compare any two different files together in the context of your existing Bump documentation. This means you will still need to be authenticated with your API on Bump to compare two given files or URLs. Here's how you would do it:

  $ bump diff openapi-file.yml next-openapi-file.yml --doc <doc_slug> --token <your_doc_token>
  * Let's compare the two given definition files... done
  
  Updated: POST /users
    Body attribute added: postcode

  In a future version, you will also be able to use the bump diff command without authentication so stay tuned!

✨