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

[Feature]: Automate releases notes using GitHub Actions #366

Closed
tomvothecoder opened this issue Oct 17, 2022 · 0 comments · Fixed by #368
Closed

[Feature]: Automate releases notes using GitHub Actions #366

tomvothecoder opened this issue Oct 17, 2022 · 0 comments · Fixed by #368
Assignees
Labels
type: devops Testing, CI/CD, systems configuration type: docs Updates to documentation type: enhancement New enhancement request

Comments

@tomvothecoder
Copy link
Collaborator

tomvothecoder commented Oct 17, 2022

Is your feature request related to a problem?

The typical workflow for working with release notes is as follows:

  1. Go to GitHub Releases and fill out details with new release
  2. Click the autogenerate release notes features
  3. Format release notes and save as draft
  4. Convert release notes to .rst
  5. Copy to HISTORY.rst file, which is the changelog for the repo's documentation
  6. Merge the PR with the version bump
  7. Release on GitHub

This is a fairly tedious process that is easy to forget.

Describe the solution you'd like

We should find a way to automate generating release notes in our specific format using GitHub Actions and the create-release hook.
This video might help: https://www.youtube.com/watch?v=88FWrfHCIqo

Pre-built action: https://github.com/marketplace/actions/release-drafter

Describe alternatives you've considered

No response

Additional context

No response

@tomvothecoder tomvothecoder added type: enhancement New enhancement request type: devops Testing, CI/CD, systems configuration type: docs Updates to documentation labels Oct 17, 2022
@tomvothecoder tomvothecoder self-assigned this Oct 17, 2022
@tomvothecoder tomvothecoder changed the title [Feature]: Automate release note generation [Feature]: Automate releases using GitHub Actions Oct 17, 2022
@tomvothecoder tomvothecoder changed the title [Feature]: Automate releases using GitHub Actions [Feature]: Automate releases notes using GitHub Actions Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: devops Testing, CI/CD, systems configuration type: docs Updates to documentation type: enhancement New enhancement request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant