feat: add mix openapi.export task#1917
Draft
mandarini wants to merge 6 commits into
Draft
Conversation
mandarini
force-pushed
the
ci/openapi-drift-check
branch
from
edfa3b0 to
5d097f6
Compare
Reorder so the spec is regenerated and uploaded as an artifact before the 'snapshot committed' / 'out of date' gates run. This makes the documented one-time bootstrap actually work: on the first run (no committed priv/openapi.json yet) CI still emits the artifact, which can be downloaded and committed. The gates still enforce a committed, in-sync snapshot. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
version-type: strict against .tool-versions couldn't resolve the coarse 'erlang 27' pin (no exact match in the builds list). Match the repo's other workflows (tests.yml, lint.yml) which use otp-version: 27.x / elixir-version: 1.18.x. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mix openapi.export ran 'app.start', which boots the full supervision tree and therefore evaluates config/runtime.exs (requiring secrets like METRICS_JWT_SECRET) and opens a DB connection — neither is available in the bare OpenAPI CI job, so the export failed. The spec is derived purely from the router and compiled modules, so compile + load the app metadata instead of starting it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Commit the OpenAPI snapshot (generated by 'mix openapi.export' in CI) so the drift gate has a baseline to diff against. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What this is
mix openapi.exporttask that materializes the OpenApiSpex-generated REST spec topriv/openapi.json, plus a PR-time drift gate.What maintainers need to do
mix openapi.export, commitpriv/openapi.json.lib/realtime_web/: re-run the task and commit the updated snapshot.What it's used for
/api/openapi. Committing a snapshot makes it a static, versioned artifact SDKs and type generators can pin to.What was added and why
lib/mix/tasks/openapi.export.ex— task that writesRealtimeWeb.ApiSpec.spec()JSON topriv/openapi.json(or--output PATH)..github/workflows/openapi.yml— re-runs the task on PRs touchinglib/realtime_web/and fails ongit diffif the committed snapshot is stale. Uploads the regenerated spec as an artifact.