v1.3.1: Favor documentation name on API diff comment

❇️ Improvement

Both documentation id or slug may be used in the GitHub workflow, and this value was used for the API diff comment, when API documentation is changed by the PR.

We recently adapted our own workflow to favor id, and noticed the unexpected id usage in the comment.
With this release, the documentation name, returned by the bump-cli (since version 2.10.1) is displayed.
eat your own dog food:

🔧 Dependencies

Some libs have been bumped:

• bump fast-xml-parser from 5.5.9 to 5.9.0
• bump fast-xml-builder from 1.1.4 to 1.2.0
• bump bump-cli from 2.10.0 to 2.10.1
• more security fix with npm audit fix cf commit

v1.3.0: Deploy workflow document on an MCP server

🆕 Deploy an Arazzo workflow document on your MCP server

✨ The new MCP server deployment option (added in v1.2.10) can now receive Arazzo documents as input.

Via the GitHub action (and bump-cli under the hood), you can deploy a new workflow document (in either Flower or Arazzo specification format) on an MCP server.
More information in Readme

jobs:
  deploy-workflow-document:
    name: Deploy workflow document for MCP server on Bump.sh
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Deploy workflow document
        uses: bump-sh/github-action@v1
        with:
          command: deploy
          mcp_server: <BUMP_MCP_SERVER_ID_OR_SLUG>
          token: ${{secrets.BUMP_TOKEN}}
          file: doc/arazzo-or-flower-document.yml

Note

This feature is currently in closed beta. Request an early access at hello@bump.sh

v1.2.10: Deploy workflow document on an MCP server

🆕 New feature on deploy: deploy a workflow document on an MCP server

✨ Add new option mcp_server with command deploy

jobs:
  deploy-workflow-document:
    name: Deploy workflow document for MCP server on Bump.sh
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Deploy workflow document
        uses: bump-sh/github-action@v1
        with:
          command: deploy
          mcp_server: <BUMP_MCP_SERVER_ID_OR_SLUG>
          token: ${{secrets.BUMP_TOKEN}}
          file: doc/flower-document.yml

Note

This feature is currently in closed beta. Request an early access at hello@bump.sh

What's Changed

• Allow command 'deploy' with mcp_server parameter by @Polo2 in #581
• Readme: mention MCP server is closed beta and early access by @Polo2 in #583
• Readme: one more clarification about MCP server by @Polo2 in #584
• Bump bump-cli to version 2.9.12 by @Polo2 in #580
• 1.2.10 by @Polo2 in #585

Full Changelog: v1.2.9...v1.2.10

v1.2.7: Partial support OpenAPI 3.2

🆕 Support deployment of OpenAPI 3.2 documents 🎉

OpenAPI 3.2 was published on 19 September 2025 (see documentation), and is now partially supported by Bump.sh.

This OAS version is supported by bump-cli since last release to v2.9.9, hence the release of the GitHub action.

---

And of course, continue having fun playing with APIs 😊 ✨

v1.2.5

New 🆕

Deploying a directory containing a list of API definition files to a Hub gained two improvements:

• You can now apply a set of overlays to all the definition files during deployment. Usage:

      - name: Deploy all API documentation from docs/ directory
        uses: bump-sh/github-action@v1
        with:
          hub: <BUMP_HUB_ID>
          token: ${{secrets.BUMP_TOKEN}}
          file: docs/
          overlay: my-overlay-file.yml

• You can now define a custom filename pattern (default was {slug}-api.[format]. Usage:

      - name: Deploy all API documentation from docs/ directory
        uses: bump-sh/github-action@v1
        with:
          hub: <BUMP_HUB_ID>
          token: ${{secrets.BUMP_TOKEN}}
          file: docs/
          filename_pattern: "*-{slug}-source"

Overlay support improvements

🆕 Overlay are now supported with the diff command

You can now use the overlay: input with a list of overlay files (separated by commas) with the Diff command (input command: diff). This is similar to the current behavior on deploy commands.

I.e. running the action with the following step:

  uses: bump-sh/github-action@v1
  with:
    doc: cloud-controlplane
    token: ***
    file: my-openapi.yaml
    overlay: overlays/shared/my-overlay.yml,overlays/extra-overlay.yml
    command: diff

will create a diff on your pull requests if your my-openapi.yaml file, with both overlay files applied, has changed.

Upgrades

• The Bump CLI was upgrade to the greatest and latest 2.9.6
• Minor upgrades of external dependencies

Bugfix release on hub deployments

Bugfix 🐛

We now make sure to auto create documentation on every hub deployment (#529). This means that when deploying to a specific documentation name in a hub with the following parameters:

doc: my-super-doc
hub: my-hub
token: <bump-token>
command: deploy

The deployment will either create a new version on an existing documention if the my-super-doc exists, or create a new documentation named My super doc and deploy a first version on it.

Upgrades

Some minor dependencies upgrades.

Full Changelog: v1.2.0...v1.2.1

Upgrade of Node, bump-cli and support for overlays

What's been upgrade

• upgrade dependencies (notably bump-cli v2.9.3) and use Node 20 in #508
• The action is now packaged as an ESM module

🆕 The deploy action now supports a new input overlay

We have added overlay(s) support to the deploy command (Thanks @philsturgeon ❤️!) in #509. Simply add the new overlay: "overlay-file.yml input when using our github action and will apply the overlay to your input definition before deploying it to bump.

You can also apply multiple overlays at once by specifying a comma-separated list of files (and it also supports overlays from a remote URL), e.g.:

      - name: Deploy API definition with an overlay to Bump.sh
        uses: bump-sh/github-action@v1
        with:
          doc: <BUMP_DOC_ID>
          token: ${{secrets.BUMP_TOKEN}}
          file: doc/api-documentation.yml
          overlay: "my-overlay-file1.yml,my-overlay-file2.yml,http://internet.com/super-overlay.yml"

New Contributors

• @fbraure made their first contribution in #507. Thank you ❤️

Full Changelog: v1.1.11...v1.2.0

Publish “no structural changes” comments on diff with content change

🆕 Publish a GitHub Pull Request comment on documentation content change (with no structural changes)

• 🗨️🔗 When Bump.sh diff action is configured in your repository workflow file, we will now publish a comment if your API document file has changes without structural changes. We used to publish a comment only on structural changes, but we now also publish a comment on content-only change too (which includes a preview link to that updated document).

The release also includes some dependencies upgrades.

Have fun documenting APIs ✨

Change of GitHub Action name to reflect usage

docs: rename the GH action on marketplace

This commit modifes the Action metadata to have a more meaningful name
on the GitHub marketplace (currently when searching for “API
documentation” on the marketplace doesn't show the Bump.sh action..)