Skip to content

RELEASE.md

Latest commit

 

History

History
33 lines (20 loc) · 985 Bytes

RELEASE.md

File metadata and controls

33 lines (20 loc) · 985 Bytes
Raw

Releasing a new version

Steps to release a new version X.Y.Z, for maintainers.

On branch main:

Update CHANGELOG

Update CHANGELOG.md to reflect changes since last release, add the new release header. Follow these guidelines. You can list git changes with:

git log --oneline $(git describe --abbrev=0)..

Prepare for release

Edit Makefile and set 'VERSION=X.Y.Z' for the new release. Make sure you are logged in to quay.io/korrel8r to push images.

make clean; make pre-release

Use git status to verify that all changes are related to the version number change.

Commit and push your changes to origin/main with commit message 'Release X.Y.Z'

Publish the release

make release REGISTRY_BASE=quay.io/korrel8r

This does the following:

  • make clean and re-build, verify nothing changes and the working tree is clean.
  • Creates and pushes the git tag 'vX.Y.Z'
  • Updates the 'latest' image tag to point to the new images.