https://github.com/bump-sh/bump-ci-example
CI integration examples for Github Action, Travis CI, CircleCI and Gitlab CI.
https://github.com/bump-sh/bump-ci-example
asyncapi asyncapi-specification openapi openapi-specification openapi2 openapi3
Last synced: 19 days ago
JSON representation
CI integration examples for Github Action, Travis CI, CircleCI and Gitlab CI.
- Host: GitHub
- URL: https://github.com/bump-sh/bump-ci-example
- Owner: bump-sh
- License: mit
- Created: 2018-11-05T12:59:45.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T14:03:12.000Z (about 1 month ago)
- Last Synced: 2025-04-11T22:16:53.034Z (20 days ago)
- Topics: asyncapi, asyncapi-specification, openapi, openapi-specification, openapi2, openapi3
- Language: Shell
- Homepage: https://bump.sh
- Size: 85.9 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bump CI integration examples
CI integration examples for Github Action, Travis CI, CircleCI and Gitlab CI.
Bump is a Continuous Documentation Platform: it lets you keep your API doc always synchronized with your codebase. With these CI integration examples you can automatically generate your API reference (with changelog and diff) on [Bump](https://bump.sh) from any [OpenAPI](https://github.com/OAI/OpenAPI-Specification) or [AsyncAPI](https://github.com/asyncapi/asyncapi) file.
## Examples
Here are examples for integrating Bump with the most known CI products:
- CircleCI : https://github.com/bump-sh/bump-ci-example/blob/master/.circleci/config.yml
- Gitlab CI: https://github.com/bump-sh/bump-ci-example/blob/master/.gitlab-ci.yml
- Travis CI: https://github.com/bump-sh/bump-ci-example/blob/master/.travis.yml
- GitHub action: https://github.com/bump-sh/github-action
The GitHub action example uses a dedicated action we crafted especially for you. You may find more information on our [GitHub marketplace page](https://github.com/marketplace/actions/api-documentation-on-bump).
Note that if you don't want to keep the private token and documentation id in your code base, you should use environment variables. Our CLI automatically recognizes these 3 variables:
- `BUMP_ID`: your documentation public id or slug
- `BUMP_TOKEN`: your documentation private token
- `BUMP_HUB_ID`: if using hubs, your hub public id or slug
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bump-sh/bump-ci-example. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE).
## Code of Conduct
Everyone interacting in the Bump `bump-ci-example` code repository, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bump-sh/.github/blob/master/CODE_OF_CONDUCT.md).