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..)

Add preview documentation link in pull request comment

This release includes two main improvements

🆕 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!

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

Have fun documenting APIs ✨

Fix release to make sure AsyncAPI 2.6.0 works

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 ✨