Show menu

Gitlab CI

• Bump.sh continuous integration examples
• Generate your API documentation & changelog with Gitlab CI

Bump.sh continuous integration examples #

Bump.sh offers a lot of flexibility to let you configure how it should interact with your CI pipelines.

All our generic build processes are stored in a dedicated public repository called bump-ci-example. Those processes are defined thanks to dedicated configuration files and scripts which uses the Bump.sh CLI under the hood.

For more advanced needs, consider using our API.

Generate your API documentation & changelog with Gitlab CI #

The provided example has is a two stage delivery process:

• The test stage will run an API definition diff on all your branches except the main one, to compare the changed document file with your Bump.sh documentation. It will also comment with the diff content on the related Merge Request on Gitlab if it exists.
• The deploy stage will run only on your main branch, once your API definition was merged to your main branch it will automatically be deployed to your Bump.sh documentation.

Copy-paste the following files in your own project to see start your first Bump related pipeline:

• the .gitlab-ci.yml pipeline file
• the whole .gitlab/ directory.

If you encounter an issue or have suggestions on those examples, please do file a ticket on the dedicated repo we would love to hear your feedback.