diff --git a/dev-docs/release.md b/dev-docs/release.md index ddfc01c93d..0bb3ea7529 100644 --- a/dev-docs/release.md +++ b/dev-docs/release.md @@ -2,6 +2,32 @@ # Minor +1. Ensure all needed PRs were were merged. + +2. Export the release you want to make: + + ```sh + export REL_VER=v0.1.0 + export CUR_VER="$(echo $REL_VER | awk -F. -v OFS=. '{$NF -= 1 ; print}')" + echo "Releasing $CUR_VER -> $REL_VER" + ``` +3. Create a new temporary branch for the relese: + + ```sh + git switch -c "tmp/$REL_VER" + git push + ``` + +4. Trigger the release workflow + + ```sh + gh workflow run release.yml --ref $(git rev-parse --abbrev-ref HEAD) -f kind=minor -f version="$REL_VER" + ``` +5. Review the release notes, test the binary artifact. + +6. Publish the GitHub release. + +7. Check that the release publish action succeeds. # Patch @@ -12,7 +38,6 @@ ```sh export REL_VER=v0.1.1 export CUR_VER="$(echo $REL_VER | awk -F. -v OFS=. '{$NF -= 1 ; print}')" - echo "Releasing $CUR_VER -> $REL_VER" ``` 3. Checkout the current release branch: @@ -36,3 +61,5 @@ 6. Review the release notes, test the binary artifact. 7. Publish the GitHub release. + +8. Check that the release publish action succeeds.