Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
15 lines (12 loc) · 988 Bytes

RELEASE_CHECKLIST.md

File metadata and controls

15 lines (12 loc) · 988 Bytes

Release Checklist

Overview

This document describes the checklist to publish a release via GitHub workflow.

Release Process

  1. Determine a SemVer2-valid version prefixed with the letter v for release. For example, version="v1.0.0-rc.1".
  2. Be on the main branch connected to the actual repository (not a fork) and git pull. Ensure git log -1 shows the latest commit on the main branch.
  3. Create a tag git tag -am $version $version
  4. git tag and ensure the name in the list added looks correct, then push the tag directly to the repository by git push --follow-tags.
  5. Wait for the completion of the GitHub action release-github.
  6. Check the new draft release, revise the release description, and publish the release.
  7. Submit a PR to update the version and sha256sum in README.md and wait approval for merging.
  8. Announce the release in the community.