ci: generate release changelogs in PRs without committing CHANGELOG.md#437
Open
passcod wants to merge 1 commit into
Open
ci: generate release changelogs in PRs without committing CHANGELOG.md#437passcod wants to merge 1 commit into
passcod wants to merge 1 commit into
Conversation
changelog_update was false, which suppressed changelog generation entirely — the release PR body and GitHub release notes both came out empty. Re-enable generation so the release PR body lists the changes, and gitignore CHANGELOG.md so release-plz writes it only to populate the PR body, never committing it to the repo. GitHub release notes derive from the committed file, so they remain empty by design. Co-authored-by: Claude <noreply@anthropic.com>
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.
🤖 The release-plz config had
changelog_update = false, which turned out to suppress changelog generation entirely — the most recent release PR (#425) and the GitHub release notes for v1.18.3 / bestool-tamanu-v0.9.1 all came out with empty changelog bodies.This re-enables changelog generation so the release PR body lists the changes, and gitignores CHANGELOG.md so release-plz writes the file only to populate the PR body and never commits it to the repo. No CHANGELOG.md files are tracked, so there's nothing to remove.
Trade-off worth calling out: GitHub release notes are derived by the separate release job from the committed CHANGELOG.md, so with the file gitignored they stay empty by design. The TODO listed release/tag notes as a "possibly", and keeping committed changelog files out of the repo was the priority. If populated release notes are wanted later, the alternative is to let release-plz commit the per-crate CHANGELOG.md files.
Since release-plz only runs in CI, the no-commit behaviour with a gitignored changelog should be confirmed on the next release PR.