From fcacd6589f4f01a9c7d12080cb25153721e9b19c Mon Sep 17 00:00:00 2001 From: Leonard Cohnen Date: Mon, 11 Mar 2024 16:05:44 +0100 Subject: [PATCH] dev-docs: omit current release mention from minor release --- dev-docs/release.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/dev-docs/release.md b/dev-docs/release.md index 49ada5c0cc..997cc8bbb5 100644 --- a/dev-docs/release.md +++ b/dev-docs/release.md @@ -1,6 +1,6 @@ # How to release -# Minor +## Minor 1. Ensure all needed PRs were were merged. @@ -8,9 +8,9 @@ ```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" + echo "Releasing $REL_VER" ``` + 3. Create a new temporary branch for the relese: ```sh @@ -23,6 +23,7 @@ ```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. Review and merge the auto-generated update PR for main. @@ -31,7 +32,7 @@ 8. Check that the release publish action succeeds. -# Patch +## Patch 1. Ensure all needed PRs were backported to the current release branch, and all backport PRs were merged. @@ -42,6 +43,7 @@ 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: ```sh @@ -60,6 +62,7 @@ ```sh gh workflow run release.yml --ref $(git rev-parse --abbrev-ref HEAD) -f kind=patch -f version="$REL_VER" ``` + 6. Review the release notes, test the binary artifact. 7. Publish the GitHub release.