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

Auto generate Changelog #42

Closed
cburgdorf opened this issue Sep 22, 2020 · 3 comments
Closed

Auto generate Changelog #42

cburgdorf opened this issue Sep 22, 2020 · 3 comments

Comments

@cburgdorf
Copy link
Collaborator

What is wrong

Manually writing a changelog is error prone and tedious.

How can it be fixed

Even if this isn't a Python project, I believe towncrier currently provides the best system to generate release notes.

If we want a pure rust solution then something like https://github.com/clog-tool/clog-cli can be an alternative (disclaimer: I'm the biased author) but I'm strongly in favor to use towncrier manly because:

  • it decouples changelog entries from commits
  • it is used in all other snakecharmer projects
@cburgdorf
Copy link
Collaborator Author

In case we want to go with towncrier, one thing that just occured to me is that it defaults to RST output while we need markdown. One can work around that though: twisted/towncrier#128 (comment)

@cburgdorf
Copy link
Collaborator Author

Actually, if we go with towncrier I think I will tackle this before the first release and just write down all the notes by hand that our PRs should have had included.

@cburgdorf
Copy link
Collaborator Author

This landed as part of #157

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

No branches or pull requests

1 participant