Release Checklist

This checklist will prepare v1.3.0 from v1.2.0 (minor release) or v1.3.1 from v1.3.0 (patch release). Adjust your version numbers accordingly.

Preparation

Search the code for TODOs and FIXMEs that should be resolved before releasing.
Update titles and labels for all PRs relevant for this release to aid in the changelog generation.

Automated release

Releases should be performed using the automated release pipeline.

Patch release

cherry-pick (only) the required commits from main

trigger the automated release pipeline from the existing minor version branch:

 ver=1.3.1 # replace me
 minor=$(echo $ver | cut -d '.' -f 1,2)
 gh workflow run release.yml --ref release/v$minor -F version=$ver -F kind=patch

wait for the pipeline to finish
look over the autogenerated draft release and publish it

Minor release

Merge ready PRs

trigger the automated release pipeline from main:

 ver=1.3.0 # replace me
 minor=$(echo $ver | cut -d '.' -f 1,2)
 gh workflow run release.yml --ref main -F version=$ver -F kind=minor

wait for the pipeline to finish
look over the autogenerated draft release and publish it

Post release steps

Milestones management
1. Create a new milestone for the next release
2. Add the next release manager and an approximate release date to the milestone description
3. Close the milestone for the release
4. Move open issues and PRs from closed milestone to next milestone

If the release is a minor version release, tag the latest commit on main as the start of the next pre-release phase.

nextMinorVer=$(echo "${ver}" | awk -F. -v OFS=. '{$2 += 1 ; print}')
git checkout main
git pull
git tag v${nextMinorVer}-pre
git push origin refs/tags/v${nextMinorVer}-pre

2.0 KiB Raw Blame History