✨ feat(changelog): add granular towncrier categories#3785
Merged
gaborbernat merged 2 commits intotox-dev:mainfrom Feb 20, 2026
Merged
✨ feat(changelog): add granular towncrier categories#3785gaborbernat merged 2 commits intotox-dev:mainfrom
gaborbernat merged 2 commits intotox-dev:mainfrom
Conversation
The previous 5 changelog categories (feature, bugfix, doc, removal, misc) lacked granularity for communicating the nature of changes. Deprecations and breaking changes were scattered across unrelated sections, making it harder for users to assess upgrade impact. Adopts 8 categories inspired by yarl: breaking, deprecation, feature, bugfix, doc, packaging, contrib, and misc. This gives readers clearer signal about what changed and why, particularly for breaking changes and deprecations which warrant their own sections.
On Debian/Ubuntu the system Python excludes venv/ensurepip, which breaks tools like pyproject-build that use stdlib venv internally. tox itself is unaffected since it uses virtualenv, but users hit confusing errors from commands running inside tox environments.
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 previous 5 changelog categories (feature, bugfix, doc, removal, misc) lacked granularity for communicating the nature of changes to users. Deprecations and breaking changes were scattered across unrelated sections, making it harder for users to assess upgrade impact at a glance.
This adopts 8 categories inspired by yarl's changelog:
breaking,deprecation,feature,bugfix,doc,packaging,contrib, andmisc. Each category now has a more descriptive display name (e.g. "Bug fixes" instead of "Bugfixes", "Miscellaneous internal changes" instead of "Miscellaneous"). The unusedremovaldirectory is replaced bybreakingfor backward incompatible changes, whiledeprecationgets its own dedicated section for upcoming removals.Fixes #3200