Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Release Instructions #380

Merged
merged 3 commits into from
Feb 9, 2023
Merged

Update Release Instructions #380

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff7e4a5
feat: fix release instructions
GuptaManan100 Feb 9, 2023
d69abbc
feat: improve release instructions
GuptaManan100 Feb 9, 2023
c35d294
feat: address review comments
GuptaManan100 Feb 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions docs/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
GuptaManan100 marked this conversation as resolved.
Show resolved Hide resolved

```
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.*.*`).
Expand All @@ -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:
GuptaManan100 marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -90,7 +95,13 @@ 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.

> **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).