Skip to content
This repository was archived by the owner on Dec 6, 2024. It is now read-only.

Commit ea1f94a

Browse files
committed
update release tools instructions
1 parent 152396e commit ea1f94a

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

Diff for: SIDECAR_RELEASE_PROCESS.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,21 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
5454
generator](https://github.com/kubernetes/release/tree/master/cmd/release-notes)
5555
1. Generate release notes for the release. Replace arguments with the relevant
5656
information.
57-
```
58-
GITHUB_TOKEN=<token> ./release-notes --start-sha=0ed6978fd199e3ca10326b82b4b8b8e916211c9b --end-sha=3cb3d2f18ed8cb40371c6d8886edcabd1f27e7b9 \
59-
--github-org=kubernetes-csi --github-repo=external-attacher -branch=master -output out.md
60-
```
61-
* `--start-sha` should point to the last release from the same branch. For
62-
example:
63-
* `1.X-1.0` tag when releasing `1.X.0`
64-
* `1.X.Y-1` tag when releasing `1.X.Y`
57+
* For new minor releases on master:
58+
```
59+
GITHUB_TOKEN=<token> release-notes --discover=mergebase-to-latest
60+
--github-org=kubernetes-csi --github-repo=external-provisioner
61+
--required-author="" --output out.md
62+
```
63+
* For new patch releases on a release branch:
64+
```
65+
GITHUB_TOKEN=<token> release-notes --branch=release-1.1
66+
--start-rev=v1.1.1 --end-sha=f0a9219b29cc9053047c39d149ce9b22bc7b918b
67+
--github-org=kubernetes-csi --github-repo=external-provisioner
68+
--required-author="" --output out.md
69+
```
70+
* `--start-rev` should point to the last patch release from the release branch.
71+
* `--end-sha` should point to the latest commit from the release branch.
6572
1. Compare the generated output to the new commits for the release to check if
6673
any notable change missed a release note.
6774
1. Reword release notes as needed. Make sure to check notes for breaking

0 commit comments

Comments
 (0)