Add migration information to release docs and fix scripts (#4026)

Release Notes:

- N/A
This commit is contained in:
Mikayla Maki 2024-01-17 14:10:27 -08:00 committed by GitHub
commit 9a22327b2a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 11 additions and 12 deletions

View File

@ -87,10 +87,14 @@ This means that when releasing a new version of Zed that has changes to the RPC
1. This script will make local changes only, and print out a shell command that you can use to push the branch and tag.
1. Pushing the new tag will trigger a CI build that, when finished will upload a new versioned docker image to the DigitalOcean docker registry.
1. Once that CI job completes, you will be able to run the following command to deploy that docker image. The script takes two arguments: an environment (`production`, `preview`, or `staging`), and a version number (e.g. `0.10.1`).
1. If needing a migration:
- First check that the migration is valid. The database serves both preview and stable simultaneously, so new columns need to have defaults and old tables or columns can't be dropped.
- Then use `script/deploy-migration` <release channel> <version number> (production, staging, preview, nightly). ex: `script/deploy-migration preview 0.19.0`
- If there is an 'Error: container is waiting to start', you can review logs manually with: `kubectl --namespace <enviroment> logs <pod name>` to make sure the mgiration ran successfully.
1. Once that CI job completes, you will be able to run the following command to deploy that docker image. The script takes two arguments: an environment (`production`, `preview`, or `staging`), and a version number (e.g. `0.10.1`):
```
script/deploy preview 0.10.1
```
```
script/deploy preview 0.10.1
```
1. This command should complete quickly, updating the given environment to use the given version number of the `collab` server.
1. This command should complete quickly, updating the given environment to use the given version number of the `collab` server.

View File

@ -4,7 +4,7 @@ set -eu
source script/lib/deploy-helpers.sh
if [[ $# < 2 ]]; then
echo "Usage: $0 <production|staging|preview> <tag-name> (nightly is not yet supported)"
echo "Usage: $0 <production|preview|nightly|staging> <tag-name>"
exit 1
fi
environment=$1

View File

@ -4,16 +4,11 @@ set -eu
source script/lib/deploy-helpers.sh
if [[ $# < 1 ]]; then
echo "Usage: $0 <production|staging|preview> (nightly is not yet supported)"
echo "Usage: $0 <production|preview|nightly|staging>"
exit 1
fi
environment=$1
if [[ ${environment} == "nightly" ]]; then
echo "nightly is not yet supported"
exit 1
fi
export_vars_for_environment ${environment}
target_zed_kube_cluster