@@ -46,26 +46,38 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
46
46
## Release Process
47
47
1 . Identify all issues and ongoing PRs that should go into the release, and
48
48
drive them to resolution.
49
- 1 . Download v2.8+ [ K8s release notes
50
- generator] ( https://github.com/kubernetes/release/tree/HEAD/cmd/release-notes )
49
+ 1 . Download the latest version of the
50
+ [ K8s release notes generator] ( https://github.com/kubernetes/release/tree/HEAD/cmd/release-notes )
51
+ 1 . Create a
52
+ [ Github personal access token] ( https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token )
53
+ with ` repo:public_repo ` access
51
54
1 . Generate release notes for the release. Replace arguments with the relevant
52
- information.
55
+ information.
53
56
* Clean up old cached information (also needed if you are generating release
54
57
notes for multiple repos)
55
58
``` bash
56
59
rm -rf /tmp/k8s-repo
57
60
```
58
61
* For new minor releases on master:
59
62
` ` ` bash
60
- GITHUB_TOKEN=<token > release-notes --discover=mergebase-to-latest
61
- --github-org=kubernetes-csi --github-repo=external-provisioner
62
- --required-author="" --output out.md
63
+ GITHUB_TOKEN=< token> release-notes \
64
+ --discover=mergebase-to-latest \
65
+ --org=kubernetes-csi \
66
+ --repo=external-provisioner \
67
+ --required-author=" " \
68
+ --markdown-links \
69
+ --output out.md
63
70
` ` `
64
71
* For new patch releases on a release branch:
65
72
` ` ` bash
66
- GITHUB_TOKEN=<token > release-notes --discover=patch-to-latest --branch=release-1.1
67
- --github-org=kubernetes-csi --github-repo=external-provisioner
68
- --required-author="" --output out.md
73
+ GITHUB_TOKEN=< token> release-notes \
74
+ --discover=patch-to-latest \
75
+ --branch=release-1.1 \
76
+ --org=kubernetes-csi \
77
+ --repo=external-provisioner \
78
+ --required-author=" " \
79
+ --markdown-links \
80
+ --output out.md
69
81
` ` `
70
82
1. Compare the generated output to the new commits for the release to check if
71
83
any notable change missed a release note.
0 commit comments