Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑 Enable showing news categories in towncrier log #2399

merged 2 commits into from Oct 17, 2020


Copy link

Summary of changes

This change adds news categories into the rendered changelog entries
so that it's visible what types of changes a new version brings.

Fixes #2394

Pull Request Checklist

  • Changes have tests
  • News fragment added in changelog.d. See documentation for details

changelog.d/2394.doc.rst Outdated Show resolved Hide resolved
@webknjaz webknjaz force-pushed the maintenance/towncrier-categories branch from 330b568 to c1dd317 Compare September 26, 2020 09:02
Co-Authored-By: Thomas Hisch <>
@webknjaz webknjaz force-pushed the maintenance/towncrier-categories branch from c1dd317 to a278b0f Compare September 26, 2020 09:04
Copy link

jaraco commented Oct 17, 2020

Thanks Sviatoslav for doing this.

As a side note, I'm a little sad that the changelog is committed as a static format and thus this change will apply for new changes going forward. It would be so much better if we had a structured form of the changelog that could be re-rendered with our without the categories (or other rendering features). Regardless, that's a larger concern to potentially address separately.

@jaraco jaraco merged commit 893d815 into pypa:master Oct 17, 2020
Copy link
Member Author

Yeah. I know that some other tools (like reno) keep the fragments in the tree, while others (towncrier/scriv) remove them.
Let me see if I can reconstruct the log from the Git history.

webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 17, 2020
This was caused by pypa#2399 CI invocation happening before
merging PR pypa#2427 that made Sphinx nitpicky.
Copy link
Member Author

As somebody said, an engineer is a person who will spend a day failing to automate a task that would take an hour to complete manually. That's me today :)

I've managed to reconstruct the changelog with some precision but it needs post-processing and cross-referencing. So I'll attach the script and the output here for now.


Copy link

hugovk commented Oct 18, 2020

I have a well-deserved reputation for being something of a gadget freak, and am rarely happier than when spending an entire day programming my computer to perform automatically a task that would otherwise take me a good ten seconds to do by hand.

Douglas Adams, Last Chance to See

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

Add category names to changelog
4 participants