Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.48 KB

RELEASE_CHECKLIST.md

File metadata and controls

19 lines (14 loc) · 1.48 KB
Raw

Release Checklist

Overview

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

NOTE: Make sure the dependencies in go.mod file are expected by the release. For example, if there are dependencies on certain version of notation library (notation-go or notation-core-go) or ORAS library (oras-go), make sure that version of library is released first, and the version number is updated accordingly in go.mod file. After updating go.mod file, run go mod tidy to ensure the go.sum file is also updated with any potential changes.

Release Process

  1. Determine a SemVer2-valid version prefixed with the letter v for release. For example, version="v1.0.0-alpha.1".
  2. Bump up the Version in internal/version/version.go and open a PR for the changes.
  3. Wait for the PR merge.
  4. 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.
  5. Create a tag git tag -am $version $version
  6. 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.
  7. Wait for the completion of the GitHub action release-github.
  8. Check the new draft release, revise the release description, and publish the release.
  9. Announce the release in the community.