diff --git a/RELEASE_CHECKLIST.md b/RELEASE_CHECKLIST.md index 7c88730ae..e75c266ec 100644 --- a/RELEASE_CHECKLIST.md +++ b/RELEASE_CHECKLIST.md @@ -4,8 +4,9 @@ This document describes the checklist to publish a release via GitHub workflow. -## Release Process +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. +## Release Process 1. Determine a [SemVer2](https://semver.org/)-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](internal/version/version.go#L5) and open a PR for the changes. 3. Wait for the PR merge.