Status: Active Type: Process Created: 2020-10-08 Authors: Łukasz Langa <[email protected]> RFC PR: `edgedb/rfcs#0022 <https://github.com/edgedb/rfcs/pull/22/>`_
This document describes how we're releasing a new version of EdgeDB. This includes both the CLI tool and the server, as well as announcements.
In general, the order of releasing various components should be the following: bindings, CLI, server.
This means that we want to make sure that the nightly bindings work with the old and the new server. Similarly, we want to make sure that the nightly CLI works with the old and new server.
- Check with the team on the
#engineering
channel in Slack whether there are any release blockers. - Check if the latest nightly build of the CLI and of the server was green.
- Perform the pre-release testing to ensure that the users have a smooth upgrading experience.
The "bindings" in the checklist below refer to all of our currently supported bindings:
- Python bindings.
- JavaScript and TypeScript bindings.
- Go bindings.
- Deno bindings.
All of the binding tests need to be performed for each of our supported bindings.
- Using an old version (stable release) of CLI and server, either initialize a new project or restore an existing one.
- Update the bindings to the nightly version.
- Try to connect and run some queries using the new bindings and an old (stable release) version of the server.
- Update the CLI to the nightly version.
- Try connecting to the old (stable release) server instances. Run queries.
- Create a new project using the old server to run instances. Make
sure the following sub-tasks are possible:
- successfully initialize a new project
- connect to it
- run queries
- perform at least one migration
- Upgrade the server to the nightly build.
- Try to connect to an existing (freshly upgraded) project via the CLI and run queries.
- Try to connect and run some queries using the new bindings and the freshly upgraded project.
- Try initializing a new project using the nightly server. Make sure
the following sub-tasks are possible:
- successfully initialize a new project
- connect to it
- run queries
- perform at least one migration
- Try to connect and run some queries using the new bindings and the freshly created project.
Create a release branch if not exists (assuming you release 2.2.0):
git switch -c stable/2.2.x
- update version if needed in
Cargo.toml
and runcargo check
- commit (ideally with a name like "edgedb-cli 2.2.0")
Tag the commit:
git tag -s v2.2.0
for major releases the message can be something like:
v2.0.0 "Sagittarius" See changelog at https://github.com/edgedb/edgedb/blob/master/docs/changelog/2_x.rst
for a minor/bugfix release no description is usually necessary
git push --atomic -u origin stable/2.2.x v2.2.0
Start the release flow by going to:
- https://github.com/edgedb/edgedb-cli/actions/workflows/release.yml?query=workflow:"Build, Test, and Publish a Release"
- select the newly pushed tag from the dropdown and press "Run Workflow"
Update version in
master
branch to the next minor version:git switch -c bump23
- update
Cargo.toml
and runcargo check
- commit (ideally with a name like "Bump main to 2.3.0-dev")
git push -u origin bump23
- Create a PR from the newly created branch
Note
Only build the server after the CLI is published.
Create a release branch:
git switch -c releases/1.0a6
Tag the last commit:
git tag -s v1.0a6
the message can be something like:
v1.0a6 "Wolf 359" See changelog at https://github.com/edgedb/edgedb/blob/master/docs/changelog/1_0_a6.rst
git push --follow-tags
- Start the release flow by going to:
- https://github.com/edgedb/edgedb/actions/workflows/release.yml?query=workflow:"Build Test and Publish a Release"
- select the newly pushed release branch from the dropdown and press "Run Workflow"
- When all is good, you can check out the tag locally, build EdgeDB
and run
edb gen-test-dumps
to generate test dumps for the version you're releasing now. Commit them to master, not to the release branch, they're not needed there.
- Update tutorial.edgedb.com to run on the latest release. The package
to update is edgedb-cloud/docker/embedded/, use the README there for
update instructions. After uploading a new package to ECR, kick the
Fargate job by running
edbcloud fargate tutorial/t1 --force
. - Update Docker Hub. This should happen automatically during the server GitHub Action release build (debian-buster).
- Update the DigitalOcean image. Instructions can be found in edgedb-deploy/digitalocean-1-click/README.md.
- Update the Homebrew tap.
The tap is auto-updating nightly. If you need to bump it faster, use the HTTP repository dispatch documented in the README of the tap.
Alternatively, on an installed Homebrew the repository lives in
/usr/local/Homebrew/Library/Taps/edgedb/homebrew-tap
. Go there
and run ./autoupdate.py
, commit and push the changes.
A number of places on the Downloads page refer to a particular version. In particular you want to update:
- src/pages/download.jsx
- src/pages/index.jsx
- content/download/linux.centos.md
- content/download/linux.ubuntu.*
- content/download/linux.debian.*
Looking for a theme in the changelog is a good way to phrase the announcement blog post. Remember to give the post a fresh UUID.