Skip to content

v2.7.0 (2023-06-13) Deploy multiple documentation files to a hub all at once

Compare
Choose a tag to compare
@github-actions github-actions released this 13 Jun 17:40
· 61 commits to main since this release
b20c948

TL;DR

  • 🆕 deploy multiple files at once on your Hub with bump deploy --hub my-hub DIRECTORY
  • 🧹 Minor improvements
  • 🆙 Internal refactoring & upgrades

Detailed changlog

deploy multiple files at once on your Hub

You can now provide a directory path instead of being limited to a single file path only.

Use the deploy command to easily target a hub: bump deploy --hub my-hub DIRECTORY .

It will allow you to deploy all the files within the specified directory to your desired my-hub hub on Bump.sh.

Want to select a list of files based on your file naming convention?

Use the --filename-pattern <pattern> flag. This pattern can include * wildcard special character, {slug} a filter which will extract your documentation slug from the filename, and any other fixed characters. A picture is worth a thousand words:

Here is an example where you would want to deploy the whole my/directory/ directory to your my-hub Hub with the following command.

bump deploy my/directory/ --hub my-hub --filename-pattern *-api-{slug}-service

Where the directory holds those files:

my/dir/
└─ private-api-users-service.yml
└─ partner-api-payments-service.yml
└─ public-api-contracts-service.yml

All of the three files shown above will be deployed to your Bump.sh Hub with users, payments and contracts being the respective documentation slugs.

Minor improvements

  • The live preview feature (bump preview --live my-definition-api.yml) will create a first preview straight away without waiting for a first change on the target file.
  • The CLI will warn you if you run an out-dated version. No excuses to keep some old dangling versions on your machine 🙂

Internals & upgrades

  • We’ve refactored the deployment related code quite a bit to receive the new “Multiple files deploy” feature.
  • Upgrade to TypeScript 4.5
  • Some dependencies upgrades thanks to dependabot

Have fun designing APIs 😊 ✨