Skip to content

Commit 473d3bb

Browse files
committed
docs: clarify release checklist branch
Signed-off-by: Zakhar Dvurechensky <72825626+Zakharden@users.noreply.github.com>
1 parent 18d1827 commit 473d3bb

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

community/release_checklist.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,12 @@ following:
7070
export RELEASE_NAME=vX.Y.0
7171
export RELEASE_BRANCH_NAME="release-X.Y"
7272
export RELEASE_CANDIDATE_NAME="$RELEASE_NAME-rc.1"
73+
export DEVELOPMENT_BRANCH=main
7374
```
7475

76+
Use `main` for Helm 4 and later releases. Use `dev-v3` when releasing from the
77+
Helm 3 development branch.
78+
7579
If you are creating a patch release, use the following instead:
7680

7781
```shell
@@ -109,11 +113,11 @@ Debian](https://debian-administration.org/article/451/Submitting_your_GPG_key_to
109113
Major releases are for new feature additions and behavioral changes *that break
110114
backwards compatibility*. Minor releases are for new feature additions that do
111115
not break backwards compatibility. To create a major or minor release, start by
112-
creating a `release-X.Y` branch from main.
116+
creating a `release-X.Y` branch from the development branch.
113117

114118
```shell
115119
git fetch upstream
116-
git checkout upstream/main
120+
git checkout upstream/$DEVELOPMENT_BRANCH
117121
git checkout -b $RELEASE_BRANCH_NAME
118122
```
119123

@@ -202,7 +206,7 @@ git commit -m "bump version to $RELEASE_NAME"
202206
```
203207
204208
This will update it for the $RELEASE_BRANCH_NAME only. You will also need to
205-
pull this change into the main branch for when the next release is being
209+
pull this change into the development branch for when the next release is being
206210
created, as in [this example of 3.2 to
207211
3.3](https://github.com/helm/helm/pull/8411/files), and add it to the milestone
208212
for the next release.
@@ -211,8 +215,8 @@ for the next release.
211215
# get the last commit id i.e. commit to bump the version
212216
git log --format="%H" -n 1
213217

214-
# create new branch off main
215-
git checkout main
218+
# create new branch off the development branch
219+
git checkout $DEVELOPMENT_BRANCH
216220
git checkout -b bump-version-<release_version>
217221

218222
# cherry pick the commit using id from first command
@@ -293,7 +297,7 @@ speaking, it is better to let a release roll over the deadline than to ship a
293297
broken release.
294298
295299
Each time you'll want to produce a new release candidate, you will start by
296-
adding commits to the branch by cherry-picking from main:
300+
adding commits to the branch by cherry-picking from the development branch:
297301
298302
```shell
299303
git cherry-pick -x <commit_id>

0 commit comments

Comments
 (0)