Skip to content

ci: keep openapi.json and the adapter manifest versioned with the package - #440

Merged
Bccorb merged 1 commit into
mainfrom
ci/openapi-version-drift
Oct 17, 2026
Merged

Bccorb merged 1 commit into
mainfrom
ci/openapi-version-drift

Conversation

@Bccorb

@Bccorb Bccorb commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Closes #395. Part of the v0.19 release (#385).

Why

openapi.json and adapter-manifest.json said 0.17.0 through the whole 0.18.0 release. Changesets bumps package.json in the version step but never regenerated either file, and the contract test skipped info for exactly that reason. Nothing compared the committed manifest at all.

What

  • version-packages now runs changeset version && npm run generate:api, so every release PR carries regenerated files at the new version
  • The contract test compares the whole document (no info exclusion), checks info.version against package.json, and compares the committed adapter-manifest.json with the live manifest, including apiVersion
  • Regenerated both files at 0.18.0
  • Patch changeset

Once this merges, the Changesets action reruns the version script and the open release PR (#425) picks up both files at 0.19.0.

Checks

  • npm run typecheck: pass
  • npm run lint: pass
  • npm run format:check: pass
  • npm run coverage: 136 files, 1812 passed, 1 todo. Statements 98.9%, branches 95.37%, functions 99.26%, lines 99.14%
  • The new tests failed on main before regenerating (apiVersion 0.17.0 vs 0.18.0), so they catch the drift

Not a contract change: no routes, schemas or tokens change, only the version fields.

…kage

Regenerate both in the Changesets version step and fail the contract test
when either drifts from the routes or from package.json.

Closes #395
@Bccorb
Bccorb merged commit b6e8d7c into main Oct 17, 2026
7 checks passed
@Bccorb
Bccorb deleted the ci/openapi-version-drift branch October 17, 2026 01:03
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.

ci: fail when openapi.json drifts from the package version

1 participant