From 94873049e84994f97e354e98a5557f264c37eeab Mon Sep 17 00:00:00 2001 From: junczhu Date: Wed, 18 Sep 2024 07:56:46 +0000 Subject: [PATCH] docs: some tiny improvement in release instructions --- RELEASES.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/RELEASES.md b/RELEASES.md index bbf03b1acc..bd66ae62bf 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -48,7 +48,8 @@ Applicable fixes, including security fixes, may be backported to supported relea When a minor release is required, the release commits should be merged with the `main` branch when ready. * Alpha and Beta releases will be cut from the main branch. -* For RC and stable releases, a new branch `release-X.Y` will be created from `main`. Required changes for the minor release should be PRed to the `dev` branch, the change will then be cherry picked to `release-X.Y` from `main`.S +* For RC and stable releases, a new branch `release-X.Y` will be created from `main`. +* Required changes for the minor release should be PRed to the `dev` branch, the change will then be cherry picked to `release-X.Y` from `main`. ### Major releases @@ -56,7 +57,10 @@ When a major release is required, the release commits should be merged with the ### Tag and Release -**X.Y.Z** refers to the version (git tag) of Ratify that is released. Prepare the release with a [PR](https://github.com/ratify-project/ratify/pull/1031/files) to update the chart value. When the `release-X.Y` branch is ready, a tag **X.Y.Z** should be pushed. e.g. `git tag v1.1.1` and `git push --tags`. This will trigger a [Goreleaser](https://goreleaser.com/) action that will build the binaries and creates a [GitHub release](https://help.github.com/articles/creating-releases/): +**X.Y.Z** refers to the version (git tag) of Ratify that is released. + +1. Prepare the release with a [PR](https://github.com/ratify-project/ratify/pull/1031/files) to update the chart value. +2. When the `release-X.Y` branch is ready, a tag **X.Y.Z** should be pushed. e.g. `git tag v1.1.1` and `git push --tags`. This will trigger a [Goreleaser](https://goreleaser.com/) action that will build the binaries and creates a [GitHub release](https://help.github.com/articles/creating-releases/): * The release will be marked as a draft to allow an final editing before publishing. * The release notes and other fields can edited after the action completes. The description can be in Markdown. @@ -78,7 +82,7 @@ For example, if Gatekeeper _supported_ versions are v3.13 and v3.14, and Kuberne ## Post Release Activity -After a successful release, please manually trigger [quick start action](.github/quick-start.yml) to validate the quick start test is passing. Validate in the run logs that the version of ratify matches the latest released version. +After a successful release, please prepare a PR to update the chart value in `dev` branch. Manually trigger [quick start action](.github/quick-start.yml) to validate the quick start test is passing. Validate in the run logs that the version of ratify matches the latest released version. ### Weekly Dev Release