Continuous integration

How to integrate your documentation deployment to your CI.

Integrate with your CI

Here, we are presenting the process that we recommend to our customers, but feel free to adapt it to your workflow/requirements.

We need two steps : a validation one, and a deployment one.

Validate the documentation file

For each branch of your code base, we want to validate that your updated documentation file is still valid and will not fail during deployment. We will use the bump validate command each time a branch is pushed and will make the build fail if the documentation file is not valid.

Then, deploy it

Once your branch has been merged into your main branch (generally the master one), you will want to deploy your new documentation file and make it live. We will use the bump deploy command.

Add our CLI tool to your project

The simplest way to use our CLI tool is to add a Gemfile to your project. You can find an example here: https://github.com/bump-sh/bump-ci-example/blob/master/Gemfile.

If you prefer not using a Gemfile , be sure to run gem install bump-cli before calling the bump command.

Examples

Here are examples for integrating Bump with the most known CI products:

Note that if you don't want to keep the private token and id in your code base, you should use environment variables. Our CLI automatically recognizes these 2 variables:

  • BUMP_ID : your documentation public id

  • BUMP_TOKEN : your documentation private token