Manage changelog
Created by: Zaharid
It might be convenient to be able to easily write somewhere what has changed when we tag the code, and put the result somewhere such as the github release page or the docs.
Some tooling might be helpful for that.
Some desirable features include:
- A list of closed issues.
- A list of merged pull requests.
- Being able to edit the result for each release to e.g. manually highlight the most important changes.
- Being able to write a changelog entry for every pull request.
- Integration with sphinx.
Things that I believe are not so useful are:
- Tools that call git log or git diff: I can do that myself, as probably can most people interested in that level of detail.
- A static changelog file that every pr has to add to: Guaranteed conflicts and headaches to no end.
- Some tool that takes control of the whole process and adds unrelated pieces of overhead and maintanance.
The Python project has https://pypi.org/project/blurb/ which allows for fine grained control but might be a bit heavy weight for us.