As a maintaner, it is quite time consuming to create a list of all the issues completed in the release, mark the author and sort them into appropriate categories. It would be nice to have a way to automate this process and speed up the creation of release notes so that releases could be done faster.
Expected behavior
Add a Github workflow that takes in a release version and date and opens a PR that updates the HISTORY.md with the new release notes.
The notes should be in the following format:
## vX.Y.Z - YYYY-MM-DD
### New Features
* {issue-name} - Issue [#{issue-number}]({issue-link}) by author
...
### Bugs Fixed
...
### Maintenance
...
Additional context
You can assume all issues will be tagged with the appropriate milestone.
If an issue doesn't have anyone assigned to it, skip the by @author part
If an issue doesn't have a tag for our common header (ie. New Features, Bugs Fixed etc.), use the header Misc.
Problem Description
As a maintaner, it is quite time consuming to create a list of all the issues completed in the release, mark the author and sort them into appropriate categories. It would be nice to have a way to automate this process and speed up the creation of release notes so that releases could be done faster.
Expected behavior
Add a Github workflow that takes in a release version and date and opens a PR that updates the HISTORY.md with the new release notes.
The notes should be in the following format:
Additional context
by @author
partMisc.