Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 1.85 KB

RELEASE.md

File metadata and controls

75 lines (52 loc) · 1.85 KB
Raw

Release

This document describes the release process and is targeted at maintainers.

Preparation

Pick a name for the new release. It must follow Semantic Versioning:

VERSION=1.0.1

Make sure that the "Unreleased" section in the changelog is up-to-date. Feel free to adjust entries for example by adding additional examples or highlighting breaking changes.

Move the content of the "Unreleased" section that will be included in the new release to a new section with an appropriate title for the release. Should the "Unreleased" section now be empty, add "Nothing." to it.

Trigger

Commit the changes. Make sure to sign the commit:

git add CHANGELOG.md
git commit -S -m "chore: Prepare release v$VERSION"
git log --show-signature -1

Push changes:

git push origin master

Check workflow runs in GitHub Actions and ensure everything is fine.

Tag the latest commit with an annotated and signed tag:

git tag -s v$VERSION -m ""
git show v$VERSION

Make sure that the tree looks good:

git log --graph --oneline --all -n 5

Push the tag itself:

git push origin v$VERSION

This triggers the release workflow which will build binaries, build and push container images, and draft a GitHub release. Monitor the release workflow run.

Wrap Up

Ensure that the new set of images has been pushed to the project's container image repository on Docker Hub here.

Go to the release page of this project on GitHub here and review the automatically created release draft.

Publish the draft.