From ff7e4a539ec0a433a4e3bea12dfe3304379f6c02 Mon Sep 17 00:00:00 2001 From: Manan Gupta Date: Thu, 9 Feb 2023 16:06:28 +0530 Subject: [PATCH 1/3] feat: fix release instructions Signed-off-by: Manan Gupta --- docs/release-process.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/release-process.md b/docs/release-process.md index 1ae5927d..94e4a84f 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -44,7 +44,16 @@ The `upgrade.sh`, `backup_restore_test.sh` and `vtorc_vtadmin_test.sh` files mus ## Cut Release -### Update Vitess Dependency +### Release + +After the PR from the prepare phase is merged, make sure your local git dir is +up-to-date with HEAD, and then create a temporary release branch on top of the long-term release branch, for instance: + +``` +git checkout -b new-release-2.7.5 origin/release-2.7 +``` + +#### Update Vitess Dependency Each Vitess Operator minor version (`vX.Y.*`) is intended to correspond to a particular Vitess major version (`vX.*.*`). @@ -70,13 +79,9 @@ so this command would update Vitess Operator to build against Vitess v9.0.0: go get vitess.io/vitess@daa60859822ff85ce18e2d10c61a27b7797ec6b8 ``` -### Release - -After the PR from the prepare phase is merged, make sure your local git dir is -up-to-date with HEAD, and then create a temporary release branch on top of the long-term release branch, for instance: - -``` -git checkout -b new-release-2.7.5 origin/release-2.7 +Following this cleanup the `go.sum` file by: +```sh +go mod tidy ``` And then, create the tag using the following command, note that you will need to replace the placeholder strings: @@ -90,7 +95,7 @@ Here we want to release the version `2.7.4`. It will be tested against Vitess `v [Docker Hub](https://hub.docker.com/repository/docker/planetscale/vitess-operator) hould automatically detect the new tag and begin building a new image. -Create a [new release](https://github.com/planetscale/vitess-operator/releases/new) -in GitHub to describe the updates users should expect. - Follow the instructions prompted by the `do_release.sh` script. You will need to push the tag and push the temporary branch to finally create a Pull Request. The Pull Request should be merged onto the release branch. + +Create a [new release](https://github.com/planetscale/vitess-operator/releases/new) +in GitHub UI and make sure to add the release-notes from the docs (if any). From d69abbc153c23b8d0e79fd8916d824cf04f2dd83 Mon Sep 17 00:00:00 2001 From: Manan Gupta Date: Thu, 9 Feb 2023 16:56:12 +0530 Subject: [PATCH 2/3] feat: improve release instructions Signed-off-by: Manan Gupta --- docs/release-process.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/release-process.md b/docs/release-process.md index 94e4a84f..84e99f00 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -97,5 +97,11 @@ hould automatically detect the new tag and begin building a new image. Follow the instructions prompted by the `do_release.sh` script. You will need to push the tag and push the temporary branch to finally create a Pull Request. The Pull Request should be merged onto the release branch. +> **Note** +> Make sure to Normal Merge the pull request i.e. merge the pull request with merge commit and not a squash merge. This is required because we create the tag +from the pull request, so in order to have the tag on the release branche's history, it has to be a normal merge. + +### UI Release + Create a [new release](https://github.com/planetscale/vitess-operator/releases/new) in GitHub UI and make sure to add the release-notes from the docs (if any). From c35d2940f4b85b74517e9e506a335cbc972d2b0e Mon Sep 17 00:00:00 2001 From: Manan Gupta Date: Thu, 9 Feb 2023 19:39:33 +0530 Subject: [PATCH 3/3] feat: address review comments Signed-off-by: Manan Gupta --- docs/release-process.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/release-process.md b/docs/release-process.md index 84e99f00..e9fdaeaa 100644 --- a/docs/release-process.md +++ b/docs/release-process.md @@ -47,7 +47,7 @@ The `upgrade.sh`, `backup_restore_test.sh` and `vtorc_vtadmin_test.sh` files mus ### Release After the PR from the prepare phase is merged, make sure your local git dir is -up-to-date with HEAD, and then create a temporary release branch on top of the long-term release branch, for instance: +up-to-date with the remote's HEAD, and then create a temporary release branch on top of the long-term release branch, for instance: ``` git checkout -b new-release-2.7.5 origin/release-2.7 @@ -84,7 +84,9 @@ Following this cleanup the `go.sum` file by: go mod tidy ``` -And then, create the tag using the following command, note that you will need to replace the placeholder strings: +#### Do-Release + +Now, create the tag using the following command, note that you will need to replace the placeholder strings: ``` OLD_VITESS_VERSION="13.0.0" NEW_VITESS_VERSION="14.0.3" NEW_OPERATOR_VERSION="2.7.4" NEXT_OPERATOR_VERSION="2.7.5" ./tools/release/do_release.sh