[Do Not Merge] Convert Misc/NEWS
so that it is managed by towncrier
#552
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.
This is a demo of a towncrier solution to python/core-workflow#6. It has ported the entire
Misc/NEWS
(at the time I forked the branch) to give a comprehensive example. I did not do a very thorough job of correctly determining if a change log entry was for a feature, bugfix, etc instead opting to just do it quickly to get an example finished.Towncrier will not run on Python 3.x until twisted/towncrier#47 is fixed (I have it patched locally, will send a PR later). In addition, the title (What's new in Python X.Y) will be a bit ugly until twisted/towncrier#46 is solved.
Overview:
Misc/News/{section}
where the section is the category short name for the change log entry (Core/Builtins, Library, etc).feature
,removal
,bugfix
,doc
,misc
).perf
type as well, as categorizing performance improvements/optimizations is a bit funky.Misc/NEWS.rst
(renamed) file contains all of the past change logs, these are free to be edited for things like typos and such. Merge conflicts should be very rare.towncrier --draft --version $VERSION
.Misc/NEWS.rst
by runningtowncrier --version $VERSION
.Misc/NEWS.rst
and delete the consumed news fragments and will stage these changes in git. It will not actually commit these changes, expecting the release manager to review them before committing them.bpo-1234.bugfix
). If there is not an issue for the change you can usehide-<anything>.<ext>
which will cause a ticket number to not appear in the change log (recommended that<anything>
be a UUID4)..doc
for the Documentation category) then the type heading is suppressed.Misc/NEWS.rst
at the location specified by the comment:.. towncrier release notes start
..misc
extension (e.g.bpo-1234.misc
). This will be placed into a "Misc" category where it is simply a list of tickets that have been fixed, with no messages (see example).pyproject.toml
.TODO:
hide-
(this should be a template only change).Example: