Skip to content

Commit 934e41b

Browse files
committed
Fix shell-snippet formatting
1 parent c637d50 commit 934e41b

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

_planetscale/docs/README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,36 @@ We do not need to keep both branches indefinitely. Once we begin deploying imag
2121
[`planetscale/mysql-server`](https://github.com/planetscale/mysql-server) is a public member of the `mysql/mysql-server` network. This is where GPL releases go. The commits we push to this public fork are squashed and omit meaningful history. This is a "code dumps" approach to open source. Nothing at PlanetScale is built or deployed from this repo.
2222

2323
The public repo has only one branch, `8.0`, which is a fork of the upstream `8.0` with our changes applied as squash merges. Exclude PlanetScale-specific content when creating squash commits for the public repo. For example:
24-
`git co -- README; rm -r .buildkite/ .dockerignore Dockerfile.* _planetscale/ build.sh docker-compose.yml`
24+
25+
```sh
26+
git co -- README
27+
rm -r .buildkite/ .dockerignore Dockerfile.* _planetscale/ build.sh docker-compose.yml
28+
```
2529

2630
The public repo has one tag per image that we have deployed broadly, with the format `8.0.23-ps1`. In general, create a commit only when rolling out a new image, which means there will be one tag per commit. The semver in each tag is the upstream version the build is based on. The final number (`1` in `ps1`) in each tag is sequential and has no semantic (i.e., compatibility) meaning.
2731

2832
# Developing
2933

3034
Clone the private repository, which will be `origin`:
31-
`git clone [email protected]:planetscale/mysql-server-private`
35+
36+
```sh
37+
git clone [email protected]:planetscale/mysql-server-private
38+
```
3239

3340
Add remotes for the public and upstream repositories:
34-
`git remote add public [email protected]:planetscale/mysql-server`
35-
`git remote add upstream https://github.com/mysql/mysql-server`
41+
42+
```sh
43+
git remote add public [email protected]:planetscale/mysql-server
44+
git remote add upstream https://github.com/mysql/mysql-server
45+
```
3646

3747
Create your development branches and PRs off of `8.0.23`, for now.
3848

3949
Create a local branch for public releases:
40-
`git fetch public 8.0:public-8.0`
50+
51+
```sh
52+
git fetch public 8.0:public-8.0
53+
```
4154

4255
Every PR gets built in CI and pushed to the ECR registry at `997601596833.dkr.ecr.us-east-1.amazonaws.com/branch/`. These are candidate builds, and you can deploy them to individual database branches using the [admin](https://admin.planetscale.com/admin/) page.
4356

@@ -50,9 +63,12 @@ For more about container management, see [`registry.md`](registry.md).
5063
Anytime there are changes worth deploying, do an open-source code dump, and update all the release channels.
5164

5265
For the open-source code dump, cherry-pick or squash-merge commits (minus PlanetScale-specific content) onto your `public-8.0` branch, and then push it and tag it:
53-
`git push public public-8.0:8.0`
54-
`git tag 8.0.NN-psN`
55-
`git push public 8.0.NN-psN`
66+
67+
```sh
68+
git push public public-8.0:8.0
69+
git tag 8.0.NN-psN
70+
git push public 8.0.NN-psN
71+
```
5672

5773
For the release channels, read the Vitess docs [here](https://coda.io/d/Vitess-Upgrades_dy3xDEfjOx5/Vitess-Upgrades_sui49), and do the MySQL equivalents. In short, create an api-bb PR to update `MYSQLD_VERSIONS` in [`database_branch.rb`](https://github.com/planetscale/api-bb/blob/main/app/models/database_branch.rb#L174), disable the [`update_mysqld_image_version`](https://admin.planetscale.com/admin/feature-flags/update_mysqld_image_version) feature flag, merge the api-bb PR, and slowly increment the feature flag to 100%. Normally, new code goes to the `next` channel only. Repeat the process with `stable` and `oldstable` a day or a week later until all branches are running the desired version of MySQL.
5874

0 commit comments

Comments
 (0)