Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 2.48 KB

MAINTENANCE.md

File metadata and controls

61 lines (41 loc) · 2.48 KB
Raw

Gatekeeper Policy Manager Maintenance Guide

This document is for GPM's maintainers. Here you will find intructions on how to perform maintenance-related activities in the project, like releasing a new version of the app, releasing a new version of the helm chart, etc.

Releasing a new version of GPM

Releasing a new version of GPM is done automatically with our CI, to trigger the release process follow the next steps:

  1. Be sure that the current state of main branch is ready to be released.
  2. Be sure that you don't have any local modifications to the files.
  3. Bump the chart version.
  4. Create release notes.
  5. Commit all changes.
  6. Run bumpversion to update the version strings automatically everywhere.

For example, assuming the latest version is 1.0.0, to release a new patch version run:

bumpversion --dry-run --verbose --new-version 1.0.1 bugfix

or to release a new minor:

bumpversion --dry-run --verbose --new-version 1.1.0 minor

Notice that the command includes a --dry-run flag, drop it to actually perform the change. You can drop the --verbose flag too.

  1. bumpversion will create some commits and tags, you'll need to push the commits and then the tags
git push
git push origin <TAG>

Releasing a new Helm Chart version

You should update the version in /chart/Chart.yaml file each time you do a release of GPM and/or when the chart content gets updated.

To release a new Helm Chart version:

  1. Update the /chart/Chart.yaml file accordingly (i.e. bumping the version of the Chart)

  2. Update the /chart/README.md file if you made changes to the chart. You can use frigate to do it automatically:

cd chart
frigate gen . > README.md

Notice that frigate will use the template in the file /chart/.frigate for formatting.

  1. Tag and push the commit. This can be done as part of the release of a version of GPM or independently.

If you want to release just a new version of the chart, notice that the pipeline by default executes the Helm Release step only if the GPM release has been successful. You might need to disable the dependency between the pipeline steps.

This is to avoid publishing a chart that references a failed build of GPM. You can use a tag like helm-chart-<version>.

⚠️ Notice that the tags gatekeeper-policy-manager-<version> are used by helm/chart-releaser.