CI: run docs pipeline when the API spec changes#392
Open
shirgoldbird wants to merge 2 commits into
Open
Conversation
Add .github/workflows/docs-pipeline.yml. It triggers on pushes to main that touch the API spec (openapi.yaml/json, voice.asyncapi.yaml/json) — plus manual workflow_dispatch. No schedule/cron: a spec change is the sole automatic entry point. Runs `pipeline/run.py generate`, which chains detect → generate → evaluate → review → promote → ship → post_review and opens a docs PR (ship gets --yes automatically). Requires an ANTHROPIC_API_KEY secret. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The .json specs are auto-generated from the .yaml sources on the PR and merge in the same commit, so watching the YAML sources alone catches every spec change without any chance of a double trigger.
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.
Adds
.github/workflows/docs-pipeline.ymlso the agentic docs pipeline runs automatically when the API spec changes.Trigger — spec change only
maintouching the spec:openapi.yaml/.jsonandvoice.asyncapi.yaml/.json(same set the spec-sync workflow watches).workflow_dispatchfor manual runs (optionalsectionto scope,dry_runto rehearse).What it runs
python pipeline/run.py generate→ detect → generate → evaluate → review → promote → ship → post_review.run.pyauto-passes--yestoship, so a run opens a docs PR.Required before it works
ANTHROPIC_API_KEY(Settings → Secrets → Actions). The pipeline can't call Claude without it.GITHUB_TOKEN(forgh) is provided automatically.Notes
workflow_dispatchwithsectionto scope; scoping push runs to the changed spec area is a future refinement.validate(code-sample execution) isn't built yet, so it's not in the chain — same as runningrun.pylocally today.🤖 Generated with Claude Code