Skip to content

Commit

Permalink
docs: some tiny improvement in release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
junczhu committed Sep 18, 2024
1 parent 161fd6b commit 9487304
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,19 @@ 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

When a major release is required, the release commits should be merged with the `main` branch when ready. Major versions will usually require multiple pre-release versions. Similar to minor releases, the new branch should be created for the RC and stable release.

### 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.
Expand All @@ -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

Expand Down

0 comments on commit 9487304

Please sign in to comment.