Skip to content

Commit 890b87a

Browse files
authored
Merge pull request #188 from pwschuurman/update-release-notes-docs
SIDECAR_RELEASE_PROCESS.md: Update release-notes syntax
2 parents 87b6c37 + 274bc9b commit 890b87a

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

SIDECAR_RELEASE_PROCESS.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -46,26 +46,38 @@ naming convention `<hostpath-deployment-version>-on-<kubernetes-version>`.
4646
## Release Process
4747
1. Identify all issues and ongoing PRs that should go into the release, and
4848
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
5154
1. Generate release notes for the release. Replace arguments with the relevant
52-
information.
55+
information.
5356
* Clean up old cached information (also needed if you are generating release
5457
notes for multiple repos)
5558
```bash
5659
rm -rf /tmp/k8s-repo
5760
```
5861
* For new minor releases on master:
5962
```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
6370
```
6471
* For new patch releases on a release branch:
6572
```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
6981
```
7082
1. Compare the generated output to the new commits for the release to check if
7183
any notable change missed a release note.

0 commit comments

Comments
 (0)