ci: verify schema.json is up to date in CI#840
Merged
Conversation
The committed schema.json and the inline AJV schema in validate.ts were managed independently with no CI check to detect drift. This adds a step that regenerates schema.json and applies Biome formatting, then fails if the result differs from what is committed.
🎉 Happy commit!
|
Code Metrics Report
Details | | main (5e1e87b) | #840 (1b6fc6c) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 99.2% | 99.2% | 0.0% |
| Files | 5 | 5 | 0 |
| Lines | 131 | 131 | 0 |
| Covered | 130 | 130 | 0 |
| Code to Test Ratio | 1:0.5 | 1:0.5 | 0.0 |
| Code | 1630 | 1630 | 0 |
| Test | 912 | 912 | 0 |
+ | Test Execution Time | 2s | 1s | -1s |Reported by octocov |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a CI step to detect when
schema.jsondrifts from the TypeScript types it is generated from.Problem:
schema.json(the external schema consumed by IDE tooling and JSON linters) and the inline AJV schema insrc/validate.tswere managed independently. CI ran lint, test, and build — but never re-rangenerate-json-schema. A change toRuleStringPatterninsrc/interfaces.tscould leaveschema.jsonstale without any CI signal.Fix: After the build step, re-run
generate-json-schemaandbiome format, then assert no diff inschema.json. If the committed file is out of date, the step fails and the author must update it.Changes
.github/workflows/test.yml: addVerify schema.json is up to datestep afterVerify dist is up to dateVerification
The new step was validated locally:
Trade-offs
bun run formatruns Biome on all files after schema regeneration, not justschema.json. This is acceptable because the formatter is deterministic — a clean working tree remains clean after formatting.validate.tsvsschema.json) is preserved. Eliminating it would requireresolveJsonModule: truein tsconfig and further changes; this CI check provides detection with minimal scope.