Bump Sh Github Action Versions Save

This release includes two main improvements

:new: Add preview documentation links in pull request comment

• 🗨️🔗 When GitHub comments on pull requests are enabled to shared the diff of an API document change, the comment now includes a link to preview the documentation with the latest changes. 🔗 Perfect to check the documentation before merging your changes!

:new: Deploy an entire directory of multiple API documents to a Bump.sh Hub

• 📂🚀 You can now deploy an entire directory of API documents to a Bump.sh hub. This was added in the CLI but was not yet possible with the GitHub action. For now the default filename-pattern is used ({slug}-api.[json|yaml] so your API documents following this filename pattern will be deployed to your target hub)

  To do so, you will need to use the hub: input parameter of the GitHub action, and change the file: input parameter to target a directory. Don't forget to remove an existing doc: input parameter :slightly_smiling_face:.

Have fun documenting APIs ✨

This is a bugfix release which contains a fix to be able to send AsyncAPI 2.6.0 definition files. There was a bug in the JS dependency tree from the bump-cli package which led to inconsistent node packages.

With this release the bug is gone! 😌

Have fun with AsyncAPI ✨

:new: New fail_on_breaking input parameter useful for the diff command

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

• The diff command can be used with a new input parameter fail_on_breaking in order for the workflow to fail if the diff contains a breaking change. This is especially useful in a CI environment when diff is computed for each pull request.

  jobs:
    api-diff:
      name: Check API diff on Bump
      runs-on: ubuntu-latest
      steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Comment pull request with API diff
        uses: bump-sh/github-action@v1
        with:
          doc: <BUMP_DOC_ID>
          token: ${{secrets.BUMP_TOKEN}}
          file: doc/api-documentation.yml
          command: diff
          # -------------
          # NEW PARAMETER
          # -------------
          fail_on_breaking: true
          # -------------
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
  

:up: Upgrade dependency (mainly bump-cli)

• AsyncAPI released their 2.6 version in February 2023. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.6.0 With this new release of the Bump GitHub Action we partially support the latest changes of the AsyncAPI spec.

Have fun designing APIs ✨

:up: Upgrade dependency (mainly bump-cli)

• AsyncAPI released their 2.5 version at the end of 2022. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.5.0 With this new release of the Bump GitHub Action we partially support the latest changes of the AsyncAPI spec.

:bug: Allow empty public_url from Diff response

• Diff responses from bump.sh don't especially have a public URL anymore. The GH action needs to support an inexistant URL.

Have fun designing APIs ✨

:up: Node v16

This is a tiny release to make sure the Bump GitHub action runs on top of node v16 and avoids displaying some warnings to our users.

Thanks @calexander3 for the feedback :blue_heart:

🆕 diff command can now be called for different Api documentations on the same repository

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

• The diff command can now be used for as many existing Bump documentation as you wish, on the same repository. This means that if you have a git repository containing multiple Api specification file, each one attached to a dedicated documentation on Bump, you can define as many diff jobs in your workflow GitHub Action file as you wish. The important point is to provide the doc: input (with the doc slug or id) to each github action invocation. cf #310

:bug: Cleanup

• Fix a warning message that was present in each action run due to missing inputs. Cf #300

🆙 Upgrades

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

Have fun designing APIs! ✨

:up: Upgrade dependency (mainly bump-cli) to support new Bump branching deployments

Two main changes in this release

• You can now specify a new input parameter branch during deployments done with this GitHub action. This is particularly useful when you want to keep multiple history available of your API documentation. For more information you can check the CLI release note.

• AsyncAPI recently released their 2.4 version last month. Check out their blog post announcement: https://www.asyncapi.com/blog/release-notes-2.4.0 With this new release of the Bump GitHub Action we partially support the latest changes of the AsyncAPI spec.

Have fun designing APIs ✨

:up: 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 ✨

🆕 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: 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.

✨