Skip to content

Update the Go SDK doc for schema hooks that now run on every commit - #76144

Merged
henry3260 merged 1 commit into
apache:mainfrom
henry3260:update-go-sdk-doc-sync-hooks
Oct 31, 2026
Merged

henry3260 merged 1 commit into
apache:mainfrom
henry3260:update-go-sdk-doc-sync-hooks

Conversation

@henry3260

@henry3260 henry3260 commented Oct 31, 2026 •

Copy link
Copy Markdown
Member

Why

go-sdk/DEVELOPMENT.md describes how the vendored schema copies under go-sdk/schema/ stay in step with the Python distributions that own them. That account went stale when sync-go-sdk-schemas stopped being a manual hook and gained the Python schema sources as triggers, so the doc now tells a contributor the opposite of what they meet:

  • It says sync-go-sdk-schemas is a manual hook and that, as a result, "nothing announces on its own that a copy has gone stale" — which is precisely the gap that change closed. A reader planning around a stale copy going unnoticed plans around a problem that no longer exists.
  • Its two refresh commands pass --hook-stage manual, which no longer selects a hook that runs at the pre-commit stage.

What

go-sdk/DEVELOPMENT.md only; no code or hook changes.

  • "The vendored schemas" — both hooks are now described as running on every commit, triggered by the Python originals as well as the copies. The paragraph that explained why re-vendoring was deliberate is replaced by one that says what the Python-side trigger buys: a schema change fails on the commit that made it, and that check is the only warning there is, because a model generated from a stale copy fails at run time by not failing — msgpack drops a message field the Go struct does not declare, so the Go side quietly sees one field fewer. It also names the case the hooks cannot cover: a release branch is a partial set of cherry-picks, so each commit can pass on main and still land there in a combination that does not hold, which is why both hooks should be run over the whole tree before tagging.
  • "Regenerating the coordinator-protocol models", step 1 — --hook-stage manual dropped, plus a note that a commit touching the task-sdk snapshot runs the hook for you, so the manual invocation is for a go-sdk maintainer moving the SDK forward deliberately rather than the only way it happens.
  • "Regenerating the Dag, task and task group specs" — same flag dropped.

related: #74047, #74091


Was generative AI tooling used to co-author this PR?
  • Yes — Claude Code (Opus 5)

sync-go-sdk-schemas stopped being manual in apache#74091, so the doc no longer
describes what a contributor meets. It still says nothing announces a stale
vendored copy, which is the problem that PR fixed, and its two refresh
commands pass --hook-stage manual, which no longer selects the hook.
@henry3260
henry3260 merged commit 9b66db8 into apache:main Oct 31, 2026
59 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants