Release 0.5.0
Release checklist:
Changes to do on the master branch before releasing:
-
update/review docs/*
and make sure it matches the current state- Update how to checkout the latest stable tag
- Update how to upgrade in
docs/upgrade.md
-
update CHANGELOG.md - Include
Known issues
- Include
-
update the version number in the VERSION
file -
commit (signed) -
Push to MR
Then, create a release branch, pin deps, and tag the release:
-
If this is a major release, create a new release branch ( v0.4
, etc.). -
Ensure all dependencies are updated and locked (locking should be done only on the release branch): -
chart versions in flux/*
-
in ansible/group_vars/all/oas.yml
:flux_source.branch
should be set to the release branch
-
-
Make sure the pipeline succeeds for the last commit before tagging. This is important because tags should not get retagged ! -
create signed tag ( git tag -s 0.2.0 -m 'Release 0.2.0'
) -
Log into readthedocs.org and update documentation for tagged versions
After release:
-
Cherry-pick all changes from the release branch into master which shouldn't be only in the 0.4.0 branch (i.e. not the commit locking the dependencies) -
Celebrate 🥂 !!