feat: support optional RELEASE_NOTES.md override for curated release notes#339
Merged
Conversation
…notes Add two steps to the release job: 1. Apply custom release notes: after GoReleaser creates the GitHub Release, check for RELEASE_NOTES.md at the repo root. If present, replace the release body via gh release edit. If absent, the auto-generated notes from release-please are used unchanged. 2. Clean up release notes file: after the release completes, create a short-lived PR to delete RELEASE_NOTES.md from main (branch protection blocks direct pushes). Uses the GitHub App token so the PR triggers CI and auto-approve. This enables an optional workflow where an LLM or human can write richer, user-facing release notes before merging the release-please PR. The pattern is purely opt-in with zero configuration changes. Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
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
1 participant
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.
What
Add support for optional LLM-curated (or hand-written) release notes in the release workflow.
How
Two new steps in the
releasejob:Apply custom release notes (after GoReleaser): checks for
RELEASE_NOTES.mdat the repo root on the tagged commit. If present, replaces the GitHub Release body viagh release edit --notes-file. If absent, auto-generated notes from release-please are used unchanged.Clean up release notes file (end of job): creates a short-lived PR to delete
RELEASE_NOTES.mdfrom main. Uses the GitHub App token so the cleanup PR triggers CI and auto-approve.Also adds
pull-requests: writepermission to the release job for the cleanup PR creation.Workflow for using it
RELEASE_NOTES.mdat the repo root with curated contentmain(e.g.,docs: add release notes for vX.Y.Z)If no
RELEASE_NOTES.mdexists, the workflow behaves identically to before. Zero configuration changes required.Matches the pattern already used in patchloom (PR #627).