ci: support curated release notes via RELEASE_NOTES.md#134
Merged
Conversation
Add two steps to the release workflow: 1. Override: if RELEASE_NOTES.md exists on the tagged commit, replace the GitHub Release body with its contents via gh release edit. 2. Cleanup: after the release, create a PR to delete RELEASE_NOTES.md from main using a GitHub App token (so the PR triggers CI/auto-approve). When no RELEASE_NOTES.md is present, behavior is unchanged (release-please auto-generated notes are used as before). 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.
Adds optional support for curated, LLM-assisted release notes.
How it works:
RELEASE_NOTES.mdat the repo root withuser-facing release notes and merge it to main via a small PR
RELEASE_NOTES.mdon the tagged commitand replaces the GitHub Release body with its contents
RELEASE_NOTES.mdfrom mainWhen no
RELEASE_NOTES.mdis present, behavior is identical to before(release-please auto-generated notes are used).
Two new steps in the release job:
gh release edit --notes-fileif foundvia the Contents API, opens a PR with auto-merge enabled. Uses a
GitHub App token so the cleanup PR triggers CI and auto-approve.