gha-buildevents follows the recommendation from the GitHub Actions team: each tag and release has a semantic version (i.e. v1.0.1). There is a major version tag (i.e. v1) that binds to the latest semantic version. If a new version is released, the major version tag is moved.
Follow these steps to create a new release:
- Create a release-prep branch:
- Update version in package.json
- Update CHANGELOG for this version
- Commit, push branch, open PR, get a review of release prep changes, and merge
- Once the pull request is merged, fetch the updated main branch.
- Apply a tag for the new version on the merged commit on main: vX.Y.Z, for example v1.1.2:
git tag -a v1.1.2 -m "v1.1.2" - Push the new version tag:
git push origin v1.1.2 - Create a new release from the Releases page
- check the "Publish this release to the GitHub Marketplace" box
- choose the version tag created above
- release title matches version number
- copy and paste the changelog entry for this version into the release description
- Update the major version tag so it points to the latest release
- with the latest release checked out locally:
git tag -fa v1 -m "Update v1 tag"
git push origin v1 --force- Review the tags on the Tags page, including the commit they reference