Repository navigation
docs(go): an rc.6 changelog section - #1706
Conversation
Everything under Unreleased landed after the rc.5 tag, so it moves under a dated rc.6 heading. Two pull requests merged since then: the stashgen json.RawMessage fixes (#1703) and encrypttest.NewClient with encrypttest's split into a module of its own (#1697, #1698). Both already have entries. rc.6 is the first release that tags two modules, so the header names the encrypttest module and its tag, and the upgrade note gives the go get line for each. Nothing under packages/eql changed since rc.5, so the attached bundle differs only in its version stamp and the note says a reinstall is not needed. The SDK's go.mod, the guest lockfiles and every generated file are unchanged.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
|
|
coderdan
left a comment
There was a problem hiding this comment.
Human pass. LGTM.
cipherstash-agent
left a comment
There was a problem hiding this comment.
Review attestation
Reviewed 88adece · posted from Claude Code · claude-opus-5-5 · effort medium
Sources: code-review · claude-opus-5-5
Skills: code-review, rust-security, review-cross-check, review-post
Findings (6): 1 major, 5 minor — 3 inline, 3 below.
languages/golang/CHANGELOG.md:63(outside diff) major The Breaking entry says onlyencrypttest.NewClientfails when the SDK andencrypttestversions differ, butContextsandAssertContextsrun the sameversionSkew()check (encrypt/encrypttest/encrypttest.go:38,:126; the package doc atclient.go:122says so). A user who calls onlyAssertContexts, the entry's own example, gets failing tests the changelog does not warn about. Write "encrypttest.NewClient,ContextsandAssertContextsfail the test when the two versions differ."languages/golang/CHANGELOG.md:79(outside diff) minor "It now namesjson.RawMessage" leaves out the case where another import of the generated file is namedjson:memberTypeExprthen writesany(stashgen/read.go:1571here,writableafter #1704), ascmd/stashgen/main_test.go:820onnextasserts. Under jsonv2 that member changes fromjsontext.Valuetoany. Add "(oranywhen another import of the generated file is namedjson)".cmd/stashgen/README.md:248has the same gap and predates this PR..github/workflows/release-golang.yml:450(outside diff) minor The changelog is right that rc.5's EQL bundle needs no reinstall, but the release body this workflow writes tells every reader to runpsql -f eql-v4-install.sql, and that bundle runsDROP SCHEMA ... CASCADE(packages/eql/src/v3/schema.sql:39). On the rc.6 page a reader who follows that line silently loses EQL-dependent indexes, views and RLS policies. Limit the line to new installs and releases whose SQL changed. The rc.4 page has the same contradiction.
Checked and not reported: encrypt/example becoming its own module (all its packages are package main and it is never released), and dating the section before the tag (rc.3, rc.4 and rc.5 were done the same way).
This PR merged into next while the review ran; the findings are against its head 88adece, and #1704's code on next was read for the json name-clash finding.
Generated by Claude Code
| Run `go generate ./...` again only if you generate code under Go 1.27 and | ||
| a struct has a `json.RawMessage` field. The Fixed section describes the | ||
| change. |
There was a problem hiding this comment.
minor The trigger is jsonv2 being on when the code was generated, not Go 1.27. On Go 1.26 with GOEXPERIMENT=jsonv2, rc.5 also wrote jsontext.Value, and that file does not build without the experiment. The condition is also too broad: only a json.RawMessage member (or an alias of it) of an ordered path's array element changed (memberTypeExpr, stashgen/read.go:1564), not every json.RawMessage field.
| Run `go generate ./...` again only if you generate code under Go 1.27 and | |
| a struct has a `json.RawMessage` field. The Fixed section describes the | |
| change. | |
| Run `go generate ./...` again if you generated code with `GOEXPERIMENT=jsonv2` | |
| (the default from Go 1.27) and an ordered path names a member of an array | |
| element whose type is `json.RawMessage` or an alias of it. The Fixed section | |
| describes the change. |
Source: code-review · claude-opus-5-5
Generated by Claude Code
| ``` | ||
|
|
||
| If your program imports `encrypttest`, add its module at the same version. | ||
| Without it, the program does not build. The Breaking section explains why. |
There was a problem hiding this comment.
minor encrypttest is meant to be imported only from _test.go files (line 51, client.go:108), and go build ./... does not load test-only imports, so it still succeeds without the second go get. Only go test and go vet fail with "no required module provides package". The same wording is at line 60 ("stops building").
| Without it, the program does not build. The Breaking section explains why. | |
| Without it, your tests do not build. The Breaking section explains why. |
Source: code-review · claude-opus-5-5
Generated by Claude Code
| listed under **Breaking**. Releases are tagged `languages/golang/vX.Y.Z`, | ||
| and `languages/golang/encrypt/encrypttest/vX.Y.Z` on the same commit. |
There was a problem hiding this comment.
minor This line gives the encrypttest tag for every release, but languages/golang/encrypt/encrypttest/v0.1.0-rc.5 and earlier tags do not exist, because the package lived inside the SDK module until rc.6. Limit it to rc.6 and later, as lines 5-7 already do.
| listed under **Breaking**. Releases are tagged `languages/golang/vX.Y.Z`, | |
| and `languages/golang/encrypt/encrypttest/vX.Y.Z` on the same commit. | |
| listed under **Breaking**. Releases are tagged `languages/golang/vX.Y.Z`, | |
| and, from rc.6, `languages/golang/encrypt/encrypttest/vX.Y.Z` on the same commit. |
Source: code-review · claude-opus-5-5
Generated by Claude Code
Summary
This PR moves the Go module's Unreleased changelog entries under a dated
0.1.0-rc.6heading. After it merges, rc.6 can be released fromnext. rc.6 is the first release that tags two Go modules: the SDK, and the newencrypttestmodule that holds the offline test client.Changes
encrypttestmodule and its tag,languages/golang/encrypt/encrypttest/vX.Y.Z. The release workflow pushes that tag on the same commit as the SDK's tag.go getline for the SDK;go getline forencrypttest, which a program that imports it now needs;go generateonly forjson.RawMessagefields generated under Go 1.27.How I checked the entries
nextafter rc.5's changelog PR (docs(go): an rc.5 changelog section #1692):json.RawMessagefixes, and fix(golang): check the import name json for a json.RawMessage member in stashgen #1704, its follow-up;encrypttestas a module of its own, which brought in feat(golang): encrypttest.NewClient, an offline client for application tests #1697 (encrypttest.NewClient).git difffrom rc.5's base commit tonextshows that these are unchanged:packages/eql(so the SQL bundle differs only in its version stamp);packages/stack-*);go.modandgo.sum;*_stash.gofile.Cargo.tomlchanged only in a comment.Note on #1704
#1704, a follow-up fix to #1703's stashgen change, merged after this PR was opened, so rc.6 includes it. It needs no changelog entry of its own: it fixes a case of #1703's fix, which has not been released yet, and the existing Fixed entry already describes the result.
Related
Refs #1696