ci: add OpenAPI drift-gate workflow (follow-up to #1342) - #1429
Merged
Merged
Conversation
4 tasks
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.
Proposed change
Adds
.github/workflows/openapi.yml— the OpenAPI drift gate that #1341/#1342 introduced alongside the generator. The cherry-pick pulled inscripts/generate-openapi.tsand thegenerate:openapi:checkscript, but not this workflow, so nothing currently enforces the check in CI. At runtime it's harmless (theprebuildhook regenerates the spec on every build), but a stale committedsrc/lib/openapi.generated.json/static/openapi.jsonwould not be caught.The job runs
npm run generate:openapi:checkon pushes tomainand on PRs that touch the route code, hooks, or the generator, and fails if the committed spec drifts from the route code. It also uploads the generatedstatic/openapi.jsonas a debug artifact.Two small cleanups vs. the copy in #1341/#1342:
permissions: contents: read(least privilege — the job only checks out and runs the generator), matching the explicit-permissions style already used inrelease.yml.CI only — no runtime or app-code changes.
Follow-up to #1342 (no separate issue).
Type of change