From 102fd8640dfff62518d3257848a80a42d27626fb Mon Sep 17 00:00:00 2001 From: Christian Simon Date: Wed, 28 Feb 2024 08:57:34 +0000 Subject: [PATCH] Add note about backports (#3019) Also make clearer what the correct release branch name should be --- docs/internal/RELEASE.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/internal/RELEASE.md b/docs/internal/RELEASE.md index 5df46bca40..65e7bb5ae0 100644 --- a/docs/internal/RELEASE.md +++ b/docs/internal/RELEASE.md @@ -4,9 +4,19 @@ To release a new version of the project you need to follow the following steps: -1. Create a new branch for the release (e.g., `release/v0.x`) -2. Create the tag for the release (e.g., `v0.x.0`) +1. Create a new branch for the release (e.g., `release/vX.Y`) +2. Create the tag for the release (e.g., `vX.Y.Z`) 3. Push the release branch and tag to the remote +4. Create a GitHub label for backports: + + ```gh label create "backport release/vX.Y" -d "This label will backport a merged PR to the release/vX.Y branch" -c "#0052cc"``` + +> [!IMPORTANT] +> The release branch should only contain the major (X) and minor (Y) version, but not the patch level (Z), for example: +> +> ✅ Correct: `release/v1.3` +> +> ⚠️ Incorrect: `release/v1.3.0` The CI will automatically handle the build and create a draft github release.