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

Automatically create GitHub releases #753

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

nitishr
Copy link
Contributor

@nitishr nitishr commented Mar 2, 2025

Closes #749.

Introduces a new GitHub Actions workflow that automates the creation of GitHub releases. The workflow is triggered on push events to tags that start with 'v', and it extracts release notes from the RELEASE.md file based on the tag version. The extracted notes are then used as the body of the created release.

Future considerations:

  • Streamline more/the rest of the release process and reduce manual effort.
  • Do this in a CircleCI instead of a GitHub workflow for uniformity and lower cognitive load. I didn't do that here because I didn't have the github token for use in CircleCI.

Testing

Verified the outcome of this workflow by updating RELEASE.md and pushing a tag to a local branch. The created release contains the extracted notes for just that release.

Introduces a new GitHub Actions workflow that automates the creation of
GitHub releases. The workflow is triggered on push events to tags that
start with 'v', and it extracts release notes from the RELEASE.md file
based on the tag version. The extracted notes are then used as the body
of the created release.
@floehopper
Copy link
Member

@nitishr This looks good to me - thank you!

Streamline more/the rest of the release process and reduce manual effort.

Agreed.

Do this in a CircleCI instead of a GitHub workflow for uniformity and lower cognitive load. I didn't do that here because I didn't have the github token for use in CircleCI.

I think I'd probably move the CI build to GitHub Actions instead unless you can think of a good reason not to.

Verified the outcome of this workflow by updating RELEASE.md and pushing a tag to a local branch. The created release contains the extracted notes for just that release.

Thanks for testing it. I'd quite like to retrospectively create releases for all the existing release tags, so perhaps I can use the same (or a similar) script to do that when I have time and use that as a bit of a test...?

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

Successfully merging this pull request may close these issues.

Automatically create GitHub releases
2 participants