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

RFC: Enable Towncrier based change log support #1631

Closed
harshanarayana opened this issue Jul 11, 2019 · 2 comments · Fixed by #1632
Closed

RFC: Enable Towncrier based change log support #1631

harshanarayana opened this issue Jul 11, 2019 · 2 comments · Fixed by #1632
Labels

Comments

@harshanarayana
Copy link
Contributor

Enable usage of towncrier to generate and manage the release change logs automatically.

@andreymal
Copy link
Contributor

Automatic changelogs are awful.

No automatics can make a good changelog, like this: https://docs.djangoproject.com/en/2.2/releases/2.0/

Or at least like this: https://websockets.readthedocs.io/en/stable/changelog.html

@harshanarayana
Copy link
Contributor Author

@andreymal towncrier provides a mechanism whereby you can create a .bugfix .feature file in a specific directory with right markdown template and all it does is gather them and generate clean output with proper groupings.

This in no way is a replacement to manual detailed change logs but this is better than having to sit and go over the commit to extract meaningful information to generate Changelogs during the release time,.

harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 13, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 13, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 13, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 13, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 13, 2019
… detail to contribution guides

Signed-off-by: Harsha Narayana <[email protected]>
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 14, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 14, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 14, 2019
@yunstanford yunstanford changed the title Enable Towncrier based change log support RFC: Enable Towncrier based change log support Jul 20, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 23, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 24, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 24, 2019
harshanarayana added a commit to harshanarayana/sanic that referenced this issue Jul 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants