Skip to content

Commit 79ca0eb

Browse files
committed
Added tip from Björn + Grammarly.
Signed-off-by: bwplotka <[email protected]>
1 parent 078f11f commit 79ca0eb

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,21 @@ See the [contributing guidelines](CONTRIBUTING.md) and the
7272

7373
### For Maintainers: Release Process
7474

75-
To cut minor version:
75+
To cut a minor version:
7676

77-
1. Create new branch `release-<major>.<minor>` on top of main commit you want to cut version from and push it.
78-
2. Create new branch on top of release branch.
79-
3. Change `VERSION` file.
77+
1. Create a new branch `release-<major>.<minor>` on top of the `main` commit you want to cut the version from and push it.
78+
2. Create a new branch on top of the release branch, e.g. `<yourname>/cut-<major>.<minor>.<patch>`,
79+
3. Change the `VERSION` file.
8080
4. Update `CHANGELOG` (only user-impacting changes to mention).
81-
5. Create PR, get it reviewed.
82-
6. Once merged, create release for `release-<major>.<minor>` tag on GitHub with `<version> / <date>` title.
83-
7. Announce on prometheus-announce mailing list, slack and Twitter.
84-
8. Merge release branch back to main using "merge without squashing" approach (!).
81+
5. Create PR, and get it reviewed.
82+
6. Once merged, create a release with the `release-<major>.<minor>` tag on GitHub with the `<version> / <date>` title.
83+
7. Announce on the prometheus-announce mailing list, slack and Twitter.
84+
8. Merge the release branch back to the `main` using the "merge without squashing" approach (!).
8585

86-
To cut patch version:
86+
> NOTE: In case of merge conflicts, you can checkout the release branch in a new branch, e.g. <yourname>/resolve-conflicts`, fix the merge problems there, and then do a PR into main from the new branch. In that way, you still get all the commits in the release branch back into `main`, but leave the release branch alone.
8787
88-
1. Create branch on top of release branch you want to use.
89-
2. Cherry-pick fixes from main or add commits to fix critical bugs only for that patch release.
88+
To cut the patch version:
89+
90+
1. Create a branch on top of the release branch you want to use.
91+
2. Cherry-pick the fixes from the `main` branch (or add new commits) to fix critical bugs for that patch release.
9092
3. Follow steps 3-8 as above.

0 commit comments

Comments
 (0)