-
Notifications
You must be signed in to change notification settings - Fork 94
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use towncrier for changelog generation #5634
Conversation
In response to a question Dave asked: although these changelog fragments will be included into the master branch in sync PRs, once we do a maintenance release and subsequent sync PR, the deleted fragments will also be removed on master so you won't get duplicate entries under maintenance and minor sections in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Willing to give it a go.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice 👍
https://towncrier.readthedocs.io/en/stable/index.html
If we go for this it means no more changelog conflicts 🎉 Instead you either
changes.d/<PR-number>.<break|feat|fix>.md
towncrier create <PR-number>.<break|feat|fix>.md --content "<insert content here>"
and before the release they get collated into
CHANGES.md
.Also it guarantees changelog entries go under the right release section despite any milestone bump-backs or cherry-picks that happen.
Closes #4356
Check List
CONTRIBUTING.md
and added my name as a Code Contributor.conda-environment.yml