WIP: Add release-notes generator script and update release docs#1785
Open
wallrj-cyberark wants to merge 6 commits intocert-manager:masterfrom
Open
WIP: Add release-notes generator script and update release docs#1785wallrj-cyberark wants to merge 6 commits intocert-manager:masterfrom
wallrj-cyberark wants to merge 6 commits intocert-manager:masterfrom
Conversation
cert-manager-prow
bot
added
dco-signoff: yes
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
cert-manager-prow
bot
added
the
size/XXL
✅ Deploy Preview for cert-manager ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
wallrj-cyberark
force-pushed
the
release-notes-generator
branch
3 times, most recently
from
51de3c4 to
a3349fd
Compare
- Add scripts/release-notes Go tool (main, tests, go.mod, go.sum) and README - Add make target generate-release-notes using CERT_MANAGER_VERSION from content/docs/variables.json to run the tool and write site release notes - Tidy make/02_mod.mk: add generate-release-notes target and fix PATH newline Signed-off-by: Richard Wall <richard.wall@cyberark.com>
- Add machine-readable {/* BEGIN/END contributors */} markers to the
- release notes to enable automated contributor extraction
- Add {/* BEGIN/END changelog */} markers around v1.18.2, v1.18.1 and
- v1.18.0 sections so the release generator can parse changelogs
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
- Remove dependency on the k8s release-notes CLI and related env vars - Re-number and streamline setup: cmrel, gcloud, gsutil, cosign - Consolidate release notes generation and add guidance to run make generate-release-notes - Clarify GitHub release publishing, website PRs, and bump versions workflow Signed-off-by: Richard Wall <richard.wall@cyberark.com>
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
wallrj-cyberark
force-pushed
the
release-notes-generator
branch
from
a3349fd to
effb7f3
Compare
…relative - Add .spelling file listing release tags v1.18.0 v1.18.1 v1.18.2 - Enable mdspell --target-relative in package.json check:spelling - Wrap release-notes filename in docs with inline code formatting Signed-off-by: Richard Wall <richard.wall@cyberark.com>
Signed-off-by: Richard Wall <richard.wall@cyberark.com>
cert-manager-prow
bot
added
the
needs-rebase
Contributor
|
PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
maelvls
reviewed
Mar 27, 2026
| @@ -0,0 +1,101 @@ | |||
| # Release Notes Generator | |||
Member
There was a problem hiding this comment.
I've tested this script, but wasn't able to run it because I hadn't create the tag yet. The release process says that I should prepare the release notes before releasing. Here is what I'm getting:
$ cd scripts/release-notes
$ go run . --release-notes-dir ../../content/docs/releases/release-notes --release-version v1.20.1
INFO[0000] Cloning/updating repository cert-manager/cert-manager
INFO[0015] Using found start SHA: 0d2f215fe26ca2674758b5dfd780f04ac1dfde92
invalid configuration: invalid notes options: resolving v1.20.1: reference not found
exit status 1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Creating and updating the release notes has always been one of the most laborious parts of the cert-manager release process for me and this script encodes various manual steps that had previously taken a long time and patience to get right.
The tool captures and automates some the tedious, error-prone steps of producing release notes so we spend less time formatting and more time reviewing content and thanking contributors.