Merge pull request #80 from msau42/add-release-process
update release tools instructions
This commit is contained in:
@@ -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
|
||||
|
Reference in New Issue
Block a user