Files
concrete/.github/ISSUE_TEMPLATE/release.md
Arthur Meyre de3a9f9bb3 chore: update release workflow for auto GitHub release creation
- update version_utils.py script to get info about prerelease
- update release template
2021-10-11 16:13:10 +02:00

1.7 KiB

name, about, title
name about title
Release Issue template to prepare a release step by step. Release vX.Y.Z (or vX.Y.Z-rc?)

Please check all steps if it was either done/already done, at the end of a release all check boxes must have been checked.

Release check-list:

If it was not already done:

  • Choose the version number, e.g. vX.Y.Z (can be vX.Y.Z-rc? for Release Candidates) following semantic versioning: https://semver.org/
  • Update the project version to X.Y.Z (or X.Y.Z-rc?) by running:
VERSION=X.Y.Z make set_version
# or
VERSION=X.Y.Z-rc? make set_version

Then:

  • For non RC releases: check the release milestone issues, cut out what can't be completed in time and change the milestones for these issues
  • Checkout the commit for release, create a signed tag (requires GPG keys setup, see here) with the version name (careful for RC) git tag -s -a -m "vX.Y.Z release" vX.Y.Z, (or vX.Y.Z-rc?) push it to GitHub with git push origin refs/tags/vX.Y.Z (or vX.Y.Z-rc?)
  • Wait for the release workflow to finish and check everything went well.

To continue the release cycle:

  • Choose the version number for next release, e.g. vA.B.C (can be vA.B.C-rc? for Release Candidates) following semantic versioning: https://semver.org/
  • Update the project version to A.B.C (or A.B.C-rc?) by running:
VERSION=A.B.C make set_version
# or
VERSION=A.B.C-rc? make set_version

All done!