chore(changelog): manage the changelog with towncrier - #93
Merged
Merged
Conversation
The repository has published releases but no assembled changelog, so what changed between two tags is only recoverable by reading commits. Adopt towncrier: each pull request adds a news fragment under `changelog/`, and a release assembles them into `CHANGELOG.md`. The fragment gate runs on pull requests into `main`, the branch releases are tagged from. It fails the author while they still have the context, rather than leaving whoever cuts the release to reconstruct it. Trivial changes opt out with the `ci/skip-changelog` label. Only the changelog layer lands here. Assembling fragments at release time (`towncrier build`) and any version bumping are a deliberate follow-up, and the existing tags are not back-filled. Fragments are excluded from markdownlint: they are prose snippets spliced under generated headings, so they have no top-level heading of their own and would fail MD041 as standalone documents. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YFXsGwbrSC3CMY4FdJncYB
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 repository has published releases but no assembled changelog, so what changed between two tags is only recoverable by reading commits. Adopt towncrier: each pull request adds a news fragment under
changelog/, and a release assembles them intoCHANGELOG.md.The fragment gate runs on pull requests into
main, the branch releases are tagged from. It fails the author while they still have the context, rather than leaving whoever cuts the release to reconstruct it. Trivial changes opt out with theci/skip-changeloglabel.Only the changelog layer lands here. Assembling fragments at release time (
towncrier build) and any version bumping are a deliberate follow-up, and the existing tags are not back-filled.Fragments are excluded from markdownlint: they are prose snippets spliced under generated headings, so they have no top-level heading of their own and would fail MD041 as standalone documents.