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

Add workflow to generate release notes #404

Closed
amontanez24 opened this issue Oct 18, 2024 · 0 comments · Fixed by #405
Closed

Add workflow to generate release notes #404

amontanez24 opened this issue Oct 18, 2024 · 0 comments · Fixed by #405
Assignees
Labels
internal The issue doesn't change the API or functionality
Milestone

Comments

@amontanez24
Copy link
Contributor

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:

## 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.
@amontanez24 amontanez24 added internal The issue doesn't change the API or functionality new Label applied to new issues and removed new Label applied to new issues labels Oct 18, 2024
@amontanez24 amontanez24 self-assigned this Oct 18, 2024
@amontanez24 amontanez24 added this to the 0.10.1 milestone Oct 18, 2024
@amontanez24 amontanez24 modified the milestones: 0.10.1, 0.10.2 Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal The issue doesn't change the API or functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant