Skip to content

Commit b33e73d

Browse files
committed
build/README: add step to upgrade golang.org/x packages
[Internal discussion](https://cockroachlabs.slack.com/archives/CJ0H8Q97C/p1743193919914069) Epic: none Release note: None
1 parent 8139125 commit b33e73d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

build/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,10 @@ do so:
7575
7676
# Updating the golang version
7777
78+
The Go upgrade process is documented [here](https://cockroachlabs.atlassian.net/wiki/spaces/devinf/pages/4193714322/CockroachDB+Go+upgrade+policy+and+process).
79+
This checklist is meant to be followed by the dev-inf team member that
80+
performs the upgrade and constructs the draft PR.
81+
7882
Please copy this checklist into the relevant commit message and perform these
7983
steps:
8084
@@ -87,7 +91,8 @@ steps:
8791
* [ ] Adjust `--@io_bazel_rules_go//go/toolchain:sdk_version` in [.bazelrc](../.bazelrc).
8892
* [ ] Bump the version in `WORKSPACE` under `go_download_sdk`. You may need to bump [rules_go](https://github.com/bazelbuild/rules_go/releases). Also edit the filenames listed in `sdks` and update all the hashes to match what you built in the step above.
8993
* [ ] Bump the version in `WORKSPACE` under `go_download_sdk` for the FIPS version of Go (`go_sdk_fips`).
90-
* [ ] Run `./dev generate bazel` to refresh `distdir_files.bzl`, then `bazel fetch @distdir//:archives` to ensure you've updated all hashes to the correct value.
94+
* [ ] Upgrade golang.org/x packages; these are maintained by the Go project and it's reasonable to upgrade them when doing our Go upgrade. Run `grep -e '^\tgolang.org/x' go.mod | grep -v vcs | grep -v image | grep -v typeparams | cut -w -f2 | sed 's/$/@latest/' | xargs go get`. (Note: we don't upgrade certain libraries that are not linked into CRDB, hence the `grep -v`.)
95+
* [ ] Run `./dev generate bazel --mirror`, then `bazel fetch @distdir//:archives` to ensure you've updated all hashes to the correct value.
9196
* [ ] Bump the go version in `go.mod`.
9297
* [ ] Bump the default installed version of Go in `bootstrap-debian.sh` ([source](./bootstrap/bootstrap-debian.sh)).
9398
* [ ] Replace other mentions of the older version of go (grep for `golang:<old_version>` and `go<old_version>`).

0 commit comments

Comments
 (0)