Skip to content

docs: make v1.5.0 the /v1 GA compatibility baseline - #797

Merged
jiashuoz merged 1 commit into
mainfrom
docs/ga-compat-baseline
Aug 2, 2026
Merged

docs: make v1.5.0 the /v1 GA compatibility baseline#797
jiashuoz merged 1 commit into
mainfrom
docs/ga-compat-baseline

Conversation

@jiashuoz

@jiashuoz jiashuoz commented Aug 2, 2026

Copy link
Copy Markdown
Member

/v1 went GA with v1.5.0 on 2026-08-02, which fires a trigger the doc set for itself:

The first official API GA tag supersedes the commit anchor, and every later release must compare against the most recent GA tag.

So release audits should now compare against v1.5.0, not the pre-release freeze anchor af5d3c74.

What changed

The baseline command becomes:

make openapi-compat-check OPENAPI_BASE=v1.5.0:api/openapi.yaml

Verified it actually runs — a doc that prescribes a command should prescribe one that works:

bash scripts/check-openapi-compat.sh "v1.5.0:api/openapi.yaml" "api/openapi.yaml"
No changes detected

(Correct: v1.5.0 was cut from main and nothing has touched the spec since.)

What was kept, and why

The old anchor stays, explicitly marked superseded. Two reasons: audits reaching back into pre-GA history still need it, and its rationale isn't reconstructible from the commit alone — it deliberately sits after the pre-GA bounds program, because an earlier gate-introduction commit would make those approved pre-freeze bounds look retroactively breaking. Deleting it would lose that.

Scope note

This baseline is a manual release-audit instruction, not automation. CI compares against github.event.pull_request.base.sha and github.event.before; the anchor was never referenced by any workflow or the Makefile (git grep af5d3c74 matches this doc only). So this changes what a human runs during a release audit, and nothing in the automated gate.

🤖 Generated with Claude Code

The doc set its own trigger — "the first official API GA tag supersedes
the commit anchor, and every later release must compare against the most
recent GA tag" — and v1.5.0 (2026-08-02) is that tag.

Release audits now compare against v1.5.0 rather than the pre-release
freeze anchor af5d3c7. Verified the documented command runs clean:

  make openapi-compat-check OPENAPI_BASE=v1.5.0:api/openapi.yaml
  → No changes detected

The old anchor is kept, marked superseded, because audits reaching back
into pre-GA history still need it and its rationale (it deliberately sits
after the pre-GA bounds program) is not reconstructible from the commit
alone.

Note this baseline is a manual release-audit instruction, not automation:
CI compares against the pull-request base and the push-before SHA, and
never referenced the anchor.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@jiashuoz
jiashuoz merged commit 83749ca into main Aug 2, 2026
23 checks passed
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.

1 participant