Skip to main content

How to update gem files in technical documentation

This page describes the task of updating the gem files in the user-guide and runbooks used by the Cloud Platform team.

When to update

We have dependabot turned on for both the user-guide and runbook repositories. This will flag security advisories and out of date gem files via the means of a pull request.

How to update

First review the changes, do we actually need to make the change and is the advisory severe enough to take action?

If so, perform the following:

  • Open the runbooks repository and approve/merge the dependabot pull request.

  • Open the user-guide repository and approve/merge the dependabot pull request.

  • Create a new release in the user-guide repository using one minor bump from the current i.e. 1.5 to 1.6.

  • Watch the GitHub Action to ensure the build and push to dockerhub job completes successfully.

  • Bump the images in the user-guide repository GitHub Actions publish and check to reflect the new image tag.

  • Bump the images in the runbooks repository GitHub Action publish to reflect the new image tag.

This page was last reviewed on 18 October 2021. It needs to be reviewed again on 18 January 2022 by the page owner #cloud-platform .
This page was set to be reviewed before 18 January 2022 by the page owner #cloud-platform. This might mean the content is out of date.