Use towncrier to avoid conflicts in HISTORY.rst #1142
Merged
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.
See #1138
Documentation here. It is used by many many projects (attrs, pytest, numpy, ...) so it seems a good choice.
Like that, with each commit or PR, we add a news fragment (a file) in the
changelog.d
folder.Before making a new release, we call
towncrier -- version 2.3.0
and the files are parsed and added nicely to theHISTORY.rst
file. They are also deleted from thechangelog.d
folder.You can add a news fragment from the command line with:
towncrier create --content 'use towncrier' 1138.misc.rst
We have to decide the type of fragments to add. I put:
breaking
change
provider
refiner
deprecation
doc
misc
With
doc
andmisc
showing only the list of PR numbers in the changelog, not the text.Notice that it will change the formatting of the
HISTORY.rst
file, now the title for a new release with the date will be on the same line.I will add the information about how to make a new release in another PR (first handle the conflicts in
HISTORY.rst
).