From 02922acfe4ad3172726db51d4c01178823a8af2b Mon Sep 17 00:00:00 2001 From: Philippe Scorsolini Date: Mon, 7 Aug 2023 16:21:20 +0200 Subject: [PATCH] docs(release): add step for empty commit and rc tag Signed-off-by: Philippe Scorsolini --- RELEASE.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index c62c56957..8c4a28f41 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,7 +4,7 @@ In order to cut a new patch release from an existing release branch `release-X.Y`, follow these steps: -- Run the [Tag workflow][tag-workflow] on the `release-X.Y`branch with the proper release version, `vX.Y.Z`. Message suggested, but not required: `Release vX.Y.Z`. +- Run the [Tag workflow][tag-workflow] on the `release-X.Y` branch with the proper release version, `vX.Y.Z`. Message suggested, but not required: `Release vX.Y.Z`. - Draft the [new release notes], and share them with the rest of the team to ensure that all the required information is included. - Publish the above release notes. @@ -13,11 +13,12 @@ In order to cut a new patch release from an existing release branch `release-X.Y In order to cut a new minor release, follow these steps: - Create a new release branch `release-X.Y` from `master`, using the [GitHub UI][create-branch]. -- Run the [Tag workflow][tag-workflow] on the `release-X.Y`branch with the proper release version, `vX.Y.0`. Message suggested, but not required: `Release vX.Y.0`. +- Create and merge an empty commit to the `master` branch, if required to have it at least one commit ahead of the release branch. +- Run the [Tag workflow][tag-workflow] on the `master` branch with the release candidate tag for the next release, so `vX..0-rc.0`. +- Run the [Tag workflow][tag-workflow] on the `release-X.Y` branch with the proper release version, `vX.Y.0`. Message suggested, but not required: `Release vX.Y.0`. - Draft the [new release notes], and share them with the rest of the team to ensure that all the required information is included. - Publish the above release notes. - [create-branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository [new release notes]: https://github.com/crossplane/crossplane-runtime/releases/new