Skip to content

Commit

Permalink
update release tools instructions
Browse files Browse the repository at this point in the history
msau42 committed Apr 17, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 152396e commit ea1f94a
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions SIDECAR_RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
@@ -54,14 +54,21 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
generator](https://github.com/kubernetes/release/tree/master/cmd/release-notes)
1. Generate release notes for the release. Replace arguments with the relevant
information.
```
GITHUB_TOKEN=<token> ./release-notes --start-sha=0ed6978fd199e3ca10326b82b4b8b8e916211c9b --end-sha=3cb3d2f18ed8cb40371c6d8886edcabd1f27e7b9 \
--github-org=kubernetes-csi --github-repo=external-attacher -branch=master -output out.md
```
* `--start-sha` should point to the last release from the same branch. For
example:
* `1.X-1.0` tag when releasing `1.X.0`
* `1.X.Y-1` tag when releasing `1.X.Y`
* For new minor releases on master:
```
GITHUB_TOKEN=<token> release-notes --discover=mergebase-to-latest
--github-org=kubernetes-csi --github-repo=external-provisioner
--required-author="" --output out.md
```
* For new patch releases on a release branch:
```
GITHUB_TOKEN=<token> release-notes --branch=release-1.1
--start-rev=v1.1.1 --end-sha=f0a9219b29cc9053047c39d149ce9b22bc7b918b
--github-org=kubernetes-csi --github-repo=external-provisioner
--required-author="" --output out.md
```
* `--start-rev` should point to the last patch release from the release branch.
* `--end-sha` should point to the latest commit from the release branch.
1. Compare the generated output to the new commits for the release to check if
any notable change missed a release note.
1. Reword release notes as needed. Make sure to check notes for breaking

0 comments on commit ea1f94a

Please sign in to comment.