Bump is a Continuous Documentation Platform: it lets you keep your API doc always synchronized with your codebase. With this Github Action you can automatically generate your API reference (with changelog and diff) on Bump from any OpenAPI or AsyncAPI file.
Start by creating a documentation on Bump. Then add this workflow to your GitHub project:
name: Deploy documentation
on:
push:
branches:
- master
jobs:
deploy-doc:
name: Deploy API doc on Bump
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Deploy API documentation
uses: bump-sh/[email protected]
with:
id: <BUMP_DOC_ID>
token: <BUMP_DOC_TOKEN>
file: doc/api-documentation.yml
Important: actions/checkout has to be called before this action.
-
id(required): Documentation id. Can be found in the documentation settings on https://bump.sh -
token(required): Documentation token. Can be found in the documentation settings on https://bump.sh. We recommend to use an encrypted secret. -
file: Relative path to the documentation file. Default:api-contract.yml. -
command: Bump command to execute.deploy(default): deploy a new version of the documentationvalidate: validate the documentation filepreview: create a temporary preview
-
validation: Validation to apply server side. Default:basic.basic(default): basic validationstrict: validate the file against its specification
Bug reports and pull requests are welcome on GitHub at https://github.com/bump-sh/github-action. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The scripts and documentation in this project are released under the MIT License.
Everyone interacting in the Bump github-action project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.