docs: add a note for dependencies in go.mod file. (#309)

Signed-off-by: Yi Zha <[email protected]>
notaryproject · Oct 4, 2022 · 6e8e9c5 · 6e8e9c5
1 parent f66ab6c
commit 6e8e9c5
Showing 1 changed file with 2 additions and 1 deletion.
diff --git 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.