@@ -25,19 +25,36 @@ release.
25
25
26
26
### Patch a release
27
27
28
- <!-- TODO(liorlieberman) -->
28
+ 1 . Create a new branch in your fork named something like ` <githubuser>/release-x.x.x ` . Use the new branch
29
+ in the upcoming steps.
30
+ 1 . Use ` git ` to cherry-pick all relevant PRs into your branch.
31
+ 1 . Update the version references in the codebase with the new semver tag.
32
+ 1 . Create a pull request of the ` <githubuser>/release-x.x.x ` branch into the ` release-x.x ` branch upstream
33
+ (which should already exist since this is a patch release). Add a hold on this PR waiting for at least
34
+ one maintainer/codeowner to provide a ` lgtm ` .
35
+ 1 . Create a tag using the ` HEAD ` of the ` release-x.x ` branch. This can be done using the ` git ` CLI or
36
+ Github's [ release] [ release ] page.
29
37
30
38
### Release a MAJOR or MINOR release
31
39
32
- <!-- TODO(liorlieberman) -->
40
+ 1 . Cut a ` release-major.minor ` branch that we can tag things in as needed.
41
+ 1 . Check out the ` release-major.minor ` release branch locally.
42
+ 1 . Update the version references in the codebase with the new semver tag.
43
+ 1 . Verify the changelog is up to date with the desired changes.
44
+ 1 . Create a tag using the ` HEAD ` of the ` release-x.x ` branch. This can be done using ` git tag -sa $VERSION ` CLI or
45
+ Github's [ release] [ release ] page.
46
+ 1 . Run ` git push origin $VERSION ` , this will trigger a github workflow that will create the release.
47
+ 1 . Verify the [ releases page] ( https://github.com/kubernetes-sigs/ingress2gateway/releases ) to ensure that the release meets the expectations.
48
+ 1 . Optional: Send an annoncement email to
` [email protected] ` with the subject
` [ANNOUNCE] ingress2gateway $VERSION is released `
49
+
33
50
34
51
### Release a RC release
35
52
36
53
1 . Open a PR with changes of the version references in the codebase.
37
- 2 . Include necessary changelog updates to CHANGELOG.md in this PR.
38
- 4 . Merge the PR
39
- 5 . Tag the release using the commit on main where the PR merged. This can be done using the git CLI ` git tag -sa $VERSION ` .
40
- 6 . Run ` git push origin $VERSION ` , this will trigger a github workflow that will create the release.
41
- 7 . Verify the [ releases page] ( https://github.com/kubernetes-sigs/ingress2gateway/releases ) to ensure that the release meets the expectations.
42
- <!-- TODO(liorlieberman) is this needed? -->
43
- 8 . An announcement email is sent to ` [email protected] ` with the subject ` [ANNOUNCE] kubernetes-template-project $VERSION is released `
54
+ 1 . Include necessary changelog updates to CHANGELOG.md in this PR.
55
+ 1 . Merge the PR
56
+ 1 . Tag the release using the commit on main where the PR merged. This can be done using the git CLI ` git tag -sa $VERSION ` .
57
+ 1 . Run ` git push origin $VERSION ` , this will trigger a github workflow that will create the release.
58
+ 1 . Verify the [ releases page] ( https://github.com/kubernetes-sigs/ingress2gateway/releases ) to ensure that the release meets the expectations.
59
+ 1 . Optional: Send an annoncement email to ` [email protected] ` with the subject ` [ANNOUNCE] ingress2gateway $VERSION is released `
60
+
0 commit comments