Skip to content

docs: make compatibility-matrix generation idempotent + dedupe rows - #9398

Draft
DerekFrank wants to merge 1 commit into
aws:mainfrom
DerekFrank:fix-compat-matrix-dupes
Draft

docs: make compatibility-matrix generation idempotent + dedupe rows#9398
DerekFrank wants to merge 1 commit into
aws:mainfrom
DerekFrank:fix-compat-matrix-dupes

Conversation

@DerekFrank

Copy link
Copy Markdown
Member

Problem

hack/docs/version_compatibility_gen runs on every release and unconditionally appends the release version to compatibility.yaml. Re-tags and re-runs accumulate duplicate rows — on main today, 1.12.x and 1.14.x each appear twice.

Fix

  • Idempotent append: skip when the version's appVersion: X.Y.x row is already present.
  • Dedupe: remove the existing duplicate 1.12.x / 1.14.x entries.
  • Regenerating compatibility.md from the deduped source is a no-op (the rendered matrix collapses by minimum version), so no doc churn.

Testing (local)

  • go vet passes.
  • Functional: running the generator for an existing version (v1.14.0) is now a no-op; a new version (v1.15.0) appends exactly once; a second run for v1.15.0 is a no-op.

Relates to the release-process retro item on keeping the compatibility matrix correct at release time.

version_compatibility_gen appends the release's version to compatibility.yaml on every
release, unconditionally. Re-tags and re-runs therefore accumulate duplicate rows —
1.12.x and 1.14.x each ended up listed twice.

- Skip the append when the version's appVersion row is already present (idempotent).
- Remove the existing duplicate 1.12.x and 1.14.x entries and regenerate compatibility.md.

Verified: re-running for an existing version is now a no-op; a new version appends exactly once.
@DerekFrank
DerekFrank requested a review from a team as a code owner July 14, 2026 00:40
@DerekFrank
DerekFrank marked this pull request as draft July 14, 2026 03:59
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