Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

Commit

Permalink
docs(release): document release candidate process (#2341)
Browse files Browse the repository at this point in the history
This change adds release candidate-specific details to the release
guide.

Fixes #2167

Signed-off-by: Jon Huhn <johuhn@microsoft.com>

Co-authored-by: Kalya Subramanian <42158129+ksubrmnn@users.noreply.github.com>
  • Loading branch information
nojnhuh and ksubrmnn authored Jan 22, 2021
1 parent a0fd215 commit 98d4675
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/release_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

This guide describes the process to create a GitHub Release for this project.

## Release Candidates

Release candidates (RCs) should be created before each significant release so final testing can be performed. RCs are tagged as `vX.Y.Z-rc.W`. After the following steps have been performed to publish the RC, perform any final testing with the published release artifacts for about one week.

If issues are found, submit patches to the RC's release branch and create a new RC with the tag `vX.Y.Z-rc.W+1`. Apply those same patches to the `main` branch. Repeat until the release is suitably stable.

Once an RC has been found to be stable, cut a release tagged `vX.Y.Z` using the following steps.

1. [Create a release branch](#create-a-release-branch)
1. [Update release branch with versioning changes](#update-release-branch-with-versioning-changes)
1. [Create and push a Git tag](#create-and-push-a-git-tag)
Expand Down Expand Up @@ -78,5 +86,7 @@ Make an announcement on the [mailing list](https://groups.google.com/g/openservi

## Make version changes on main branch

Skip this step if the release is a release candidate (RC).

Open a pull request against the `main` branch making the same version updates as [above](#update-release-branch-with-versioning-changes) so the latest release assets are referenced there.

0 comments on commit 98d4675

Please sign in to comment.