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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using towncrier for managing the CHANGELOG file #361

Open
mohamedmostafadawood opened this issue Apr 16, 2022 · 1 comment
Open

Using towncrier for managing the CHANGELOG file #361

mohamedmostafadawood opened this issue Apr 16, 2022 · 1 comment

Comments

@mohamedmostafadawood
Copy link
Contributor

Problem Description

Editing a changelog file doesn't sound too hard, but usually in the end it is not a developer that does this, but GitHub and this go wrong too many times.

To avoid problems like this, the pip project has been using towncrier.

Proposal

Basically, you would create a news/1234.bugfix file or a news/42.feature file. You do not touch CHANGES.rst. At release time, the person doing the release calls towncrier, which handles updating CHANGES.rst and removing the news fragments.

Useful resources

1)https://pypi.org/project/towncrier/
2)https://community.plone.org/t/using-towncrier-for-changes-rst-in-plone-packages/6486/15
3)https://gist.github.com/mauritsvanrees/92c40bc16ceaf3c375d81c995b4552c4

@anusha-shanbhog
Copy link

I have created a pr #382 to solve this issue.

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

No branches or pull requests

2 participants