fix: correct changelog category ordering#1017
Merged
gaborbernat merged 2 commits intoApr 9, 2026
Merged
Conversation
Move Bugfixes before Documentation in the 1.4.1 section and fix the towncrier template to iterate categories in definition order from pyproject.toml rather than dict insertion order from os.listdir(), which is filesystem-dependent. Closes pypa#1007
cd57e51 to
699356d
Compare
henryiii
approved these changes
Apr 9, 2026
699356d to
a0cd3cb
Compare
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
2 participants
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.
Summary
definitions.keys()order (from pyproject.toml) instead ofsection_entries.items()(filesystem-dependentos.listdir()order viasplit_fragments)Root cause: towncrier's
split_fragments()populates the category dict viasetdefault()as it processes fragmentfiles from
os.listdir(). On the CI runner that generated 1.4.1,980.bugfix.rstwas listed after991.misc.rst,placing Bugfixes after Miscellaneous.
Closes #1007