Skip to content

RELEASE.md

Latest commit

 

History

History
51 lines (37 loc) · 1.51 KB

RELEASE.md

File metadata and controls

51 lines (37 loc) · 1.51 KB

Release Guide

We use GoReleaser and GitHub workflows for automating the release process. Follow the instructions below for creating a new release.

  1. Ensure local main branch is up to date with origin/main:
git fetch --all --tags
  1. Ensure all checks are passing:
make check
  1. Update the CHANGELOG. Make sure that the format is consistent especially the version heading. We follow semantic versioning for our releases.

You can check if the file format is correct by running release-info for the new version:

go install github.com/sapcc/go-bits/tools/release-info@latest
release-info CHANGELOG.md X.Y.Z

where X.Y.Z is the version that you are planning to release.

  1. Commit the updated changelog with message: Release <version>
  2. Create and push a new Git tag:
git tag vX.Y.Z
git push
git push --tags

Important

Tags are prefixed with v and the GitHub release workflow is triggered for tags that match the v[0-9]+.[0-9]+.[0-9]+ gh-pattern.