Skip to content

Commit

Permalink
update release process (notaryproject#396)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dtzar
dtzar authored Oct 17, 2022
1 parent 080c6bb commit eb7e4f4
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions RELEASE_CHECKLIST.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@

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.
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](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.
4. Make a fresh clone of the repository, check the `git log`, and create a tag by `git tag $version`.
5. After double checking the digest of the tag, push the tag directly to the repository by `git push origin $version`.
6. Wait for the completion of the GitHub action `release-github`.
7. Check the new draft release, revise the release description, and publish the release.
8. Announce the release in the community.
1. Bump up the `Version` in [internal/version/version.go](internal/version/version.go#L5) and open a PR for the changes.
1. Wait for the PR merge.
1. 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.
1. Create a tag `git tag -am $version $version`
1. `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`.
1. Wait for the completion of the GitHub action [release-github](https://github.com/notaryproject/notation/actions/workflows/release-github.yml).
1. Check the new draft release, revise the release description, and publish the release.
1. Announce the release in the community.

0 comments on commit eb7e4f4

Please sign in to comment.