From aa05da8fa18f638d731aa6f6be2b37872d48c26f Mon Sep 17 00:00:00 2001 From: Ricky Stewart Date: Fri, 5 Feb 2021 13:58:24 -0600 Subject: [PATCH] build: fix documentation on updating the builder image given #56987 Release note: None --- build/README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/build/README.md b/build/README.md index 5937c47e3ef3..c90044451c68 100644 --- a/build/README.md +++ b/build/README.md @@ -57,10 +57,21 @@ which may or may not work (and are not officially supported). ## Basic Process -- Edit `build/builder/Dockerfile` as desired -- Run `build/builder.sh init` to test -- this will build the image locally. Beware this can take a lot of time. The result of `init` is a docker image version which you can subsequently stick into the `version` variable inside the `builder.sh` script for testing locally. -- Once you are happy with the result, run `build/builder.sh push` which pushes your image towards Docker hub, so that it becomes available to others. The result is again a version number, which you then *must* copy back into `builder.sh`. Then commit the change to both Dockerfile and `builder.sh` and submit a PR. -- Finally, use this version number to update the `builder.dockerImage` configuration parameter in TeamCity under the [`Cockroach`](https://teamcity.cockroachdb.com/admin/editProject.html?projectId=Cockroach&tab=projectParams) and [`Internal`](https://teamcity.cockroachdb.com/admin/editProject.html?projectId=Internal&tab=projectParams) projects. +- Edit `build/builder/Dockerfile` as desired. +- Run `build/builder.sh init` to test -- this will build the image locally. + Beware this can take a lot of time. The result of `init` is a docker image + version which you can subsequently stick into the `version` variable inside + the `builder.sh` script for testing locally. +- When you're happy with the result, commit your changes, submit a pull request, + and have it reviewed. +- Ask someone with permissions to run the `Build and Push new Builder Image` + build configuration in TeamCity. This will build and push the new Docker image + to [DockerHub](https://hub.docker.com/repository/docker/cockroachdb/builder). +- Copy the tag of the new image (which will look like `YYYYMMDD-NNNNNN`) into + `build/builder.sh`, re-commit your changes, and update the pull request. You + can now merge the pull request once you've got a sign-off. +- Finally, use the tag of the new image to update the `builder.dockerImage` + configuration parameter in TeamCity under the [`Cockroach`](https://teamcity.cockroachdb.com/admin/editProject.html?projectId=Cockroach&tab=projectParams) and [`Internal`](https://teamcity.cockroachdb.com/admin/editProject.html?projectId=Internal&tab=projectParams) projects. ## Updating the golang version