From 274bc9ba42c4e592eb51a4ee069d4f2afea8ccbe Mon Sep 17 00:00:00 2001 From: Peter Schuurman Date: Wed, 9 Feb 2022 12:22:11 -0800 Subject: [PATCH] Update Sidecar Release Process documentation to reference latest syntax for release-notes tool --- SIDECAR_RELEASE_PROCESS.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/SIDECAR_RELEASE_PROCESS.md b/SIDECAR_RELEASE_PROCESS.md index 1f3ed311..8977fbe6 100644 --- a/SIDECAR_RELEASE_PROCESS.md +++ b/SIDECAR_RELEASE_PROCESS.md @@ -46,10 +46,13 @@ naming convention `-on-`. ## Release Process 1. Identify all issues and ongoing PRs that should go into the release, and drive them to resolution. -1. Download v2.8+ [K8s release notes - generator](https://github.com/kubernetes/release/tree/HEAD/cmd/release-notes) +1. Download the latest version of the + [K8s release notes generator](https://github.com/kubernetes/release/tree/HEAD/cmd/release-notes) +1. Create a + [Github personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) + with `repo:public_repo` access 1. Generate release notes for the release. Replace arguments with the relevant - information. + information. * Clean up old cached information (also needed if you are generating release notes for multiple repos) ```bash @@ -57,15 +60,24 @@ naming convention `-on-`. ``` * For new minor releases on master: ```bash - GITHUB_TOKEN= release-notes --discover=mergebase-to-latest - --github-org=kubernetes-csi --github-repo=external-provisioner - --required-author="" --output out.md + GITHUB_TOKEN= release-notes \ + --discover=mergebase-to-latest \ + --org=kubernetes-csi \ + --repo=external-provisioner \ + --required-author="" \ + --markdown-links \ + --output out.md ``` * For new patch releases on a release branch: ```bash - GITHUB_TOKEN= release-notes --discover=patch-to-latest --branch=release-1.1 - --github-org=kubernetes-csi --github-repo=external-provisioner - --required-author="" --output out.md + GITHUB_TOKEN= release-notes \ + --discover=patch-to-latest \ + --branch=release-1.1 \ + --org=kubernetes-csi \ + --repo=external-provisioner \ + --required-author="" \ + --markdown-links \ + --output out.md ``` 1. Compare the generated output to the new commits for the release to check if any notable change missed a release note.