Skip to content

docs(go): an rc.6 changelog section - #1706

Merged
coderdan merged 1 commit into
nextfrom
docs/go-rc6-changelog
Nov 18, 2026
Merged

coderdan merged 1 commit into
nextfrom
docs/go-rc6-changelog

Conversation

@coderdan

@coderdan coderdan commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This PR moves the Go module's Unreleased changelog entries under a dated 0.1.0-rc.6 heading. After it merges, rc.6 can be released from next. rc.6 is the first release that tags two Go modules: the SDK, and the new encrypttest module that holds the offline test client.

Changes

  • Header: names the encrypttest module 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.
  • Upgrading from rc.5:
    • the go get line for the SDK;
    • the go get line for encrypttest, which a program that imports it now needs;
    • the EQL SQL has not changed, so a database on rc.5's bundle needs no reinstall;
    • re-run go generate only for json.RawMessage fields generated under Go 1.27.
  • The Added, Breaking and Fixed entries were already under Unreleased and are unchanged.

How I checked the entries

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

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.
@coderabbitai

coderabbitai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI; Enforced overrides: Organization
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 26efd2d3-76e6-4503-b52d-a92dee7e4496

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review

@changeset-bot

changeset-bot Bot commented Nov 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 88adece

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderdan
coderdan marked this pull request as ready for review November 18, 2026 03:38
@coderdan
coderdan requested a review from a team as a code owner November 18, 2026 03:38

@coderdan coderdan left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Human pass. LGTM.

@coderdan
coderdan merged commit 3aedcd1 into next Nov 18, 2026
34 checks passed
@coderdan
coderdan deleted the docs/go-rc6-changelog branch November 18, 2026 03:39

@cipherstash-agent cipherstash-agent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 only encrypttest.NewClient fails when the SDK and encrypttest versions differ, but Contexts and AssertContexts run the same versionSkew() check (encrypt/encrypttest/encrypttest.go:38, :126; the package doc at client.go:122 says so). A user who calls only AssertContexts, the entry's own example, gets failing tests the changelog does not warn about. Write "encrypttest.NewClient, Contexts and AssertContexts fail the test when the two versions differ."
  • languages/golang/CHANGELOG.md:79 (outside diff) minor "It now names json.RawMessage" leaves out the case where another import of the generated file is named json: memberTypeExpr then writes any (stashgen/read.go:1571 here, writable after #1704), as cmd/stashgen/main_test.go:820 on next asserts. Under jsonv2 that member changes from jsontext.Value to any. Add "(or any when another import of the generated file is named json)". cmd/stashgen/README.md:248 has 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 run psql -f eql-v4-install.sql, and that bundle runs DROP 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

Comment on lines +37 to +39
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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").

Suggested change
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

Comment on lines +11 to +12
listed under **Breaking**. Releases are tagged `languages/golang/vX.Y.Z`,
and `languages/golang/encrypt/encrypttest/vX.Y.Z` on the same commit.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants