Support for AsyncAPI 2.3

🆙 Upgrade dependency (mainly bump-cli) to support AsyncAPI 2.3

• AsyncAPI recently released 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 GitHub Action we support the latest changes of the AsyncAPI spec.

Have fun designing APIs ✨

Public availability of the `bump diff` command

🆕 diff command can now be called unauthenticated

Check our blog post announcement about our api diff feature if you've never tried it

• The diff command can now be used without the need of an account on Bump. If you want to compare two API contracts you can use our GitHub Action without any further actions. You will get your API changes commented directly into your pull requests! Here is an example configuration to be able to run API diffs on OpenAPI or AsyncAPI contracts on a public project :

  name: Diff API documentation
  
  on:
    pull_request_target:
      branches:
        - main # ← Change this to the name of your target main branch
  
  jobs:
    public-api-diff:
      if: ${{ github.event_name == 'pull_request_target' }}
      name: Check public API diff on Bump
      runs-on: ubuntu-latest
      steps:
        - name: Checkout
          uses: actions/checkout@v2
        - name: Comment pull request with API diff
          uses: bump-sh/github-action@v1
          with:
            file: openapi.yaml # ← Change this to the path of your API contract file
            command: diff
          env:
            GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

  With this workflow, any PRs opened on your repository will get an API diff update through a pull request comment. So public contributions won't need any specific access to your repository, nor any specific access to your Bump.sh account.

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot.

---

Have fun designing APIs!
✨

New format for diff comments on Pull Requests

🆕 Diff comments on pull requests are displayed in a clearer format

This release introduces a visual change in the diff comments sent to GitHub pull requests. If you don't use the diff command yet, please check out our release annoucement.

Here is a before/after to show you the new display (before in red, after in green):

The diff comment will now be more detailed and displayed in a markdown format instead of a raw text. We hope it will make your API design reviews easier. If you have feedback on the resulting format, please contact us, either via an issue on this repository or by email.

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot.

✨

Bugfix: diff with API contracts containing external references

🐛 Bug fix

This release is mainly a bugfix around the diff command.

The diff command will work without errors even for API contracts that make use of external References (with the $ref keyword referencing multiple files).

Many thanks @davidgoldelocks for reporting the initial issue. 💙

(Check our blog post announcement talking about our new bump diff - “API diff” - feature if you missed our v1.0.0 release)

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot.

✨

Bump diff will cleanup any existing comment if the diff is empty

🆕 Feature

• In the diff feature of this Github-Action, the bot will automatically delete any existing Bump comment if the API definition file diff has changed to be empty.
  This is an edge case which was not handled yet: if ever you made a change to your API definition file in a PR and finally decide to remove those changes for your current pull request.

🐛 Bug fix

• In the diff feature of this Github-Action, empty diffs could lead to incorrect Bump diff summary comments. This has been fixed in the bump-cli npm package used in this project.

Bump diff compares exact pull request changes only

This new release mostly includes a bugfix on the automated diff feature on pull requests.

🐛 Bug fix

• The automatic bump diff action will now only compare the exact changes made in your pull request, by ignoring any merge commit (GitHub automatically runs any Github-Action on a merge commit between your PR and your target branch), and checking the last common ancestor between your target branch and your PR head branch. This is hopefully the last bugfix around diff management in our github-action. Sorry to those of you who have been (patiently) sharing their issues, and especially @gmourier from Meilisearch 🙏

✨

v1.0.4

🆙 Upgrades

• Upgrade bump-cli to latest v2.2.5 in order to accept AsyncAPI files up to specification version 2.2

✨

Bump diff now compares the pull request changes

This new release mostly includes a bugfix on the automated diff feature on pull requests.

🐛 Bug fix

• The automatic bump diff (if used in your repository) action will now only compare the changes present in your pull requests instead of comparing with the latest deployed version of your documentation on bump.sh. This means the github bot comment will include a comprehensive, and consistent, summary of the API changes made in your pull request.

  You might not have seen this bug if you use a single main branch and merge PRs often. But if you had a “buffering” git branch (usually a staging branch for instance) you probably saw inconsistent API changelogs in some of the bot comments. This is now over and diff comparison will present only API changes made in your pull request 😌🎉.

✨

🆙 Upgrades

• Typescript dependency has been updated from 4.3 to 4.4

Notify breaking changes on bump diff more explicitly

This new release mostly includes a small bugfix on the GitHub automated diff comments on PRs.

🐛 Bug fix

• The bot comment on pull requests warning about the diff of your API will now be more explicit in case of breaking changes (🚨).

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot
• Minimal node version supported by the action is now v12

✨

Always update bot comment on PRs

Check our blog post announcement talking about our new api diff feature if you missed our v1.0.0 release

This new release mostly includes a small bugfix on the GitHub automated diff comments on PRs.

🐛 Bug fix

• The bot comment will now be updated every time there is a change in the resulting documentation (and not only on structural changes).

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot.

✨