Conversation
The job called Mintlify about 5s after each push, but raw.githubusercontent.com caches the spec for 300s, so builds could use a stale spec. curl also ignored HTTP errors and the job never checked the deployment result, so failures showed green. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Deployment ordering and manual-dispatch reliability issues remain unresolved.
Review effort: Lite
Findings: 1
Open (2)
What changed in this PR
Improves Mintlify documentation deployments by validating spec freshness and monitoring deployment status.
Changes:
- Adds delayed spec validation and hash checks.
- Polls Mintlify deployment results and reports failures.
- Adds manual dispatch and concurrency controls.
| File | Summary |
|---|---|
.github/workflows/mintlify-update.yml |
Updates the workflow for validated Mintlify deployments. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Cancelling a run after the POST left its Mintlify build running, so builds could finish out of order. Split the job: the wait job can be cancelled because it has no remote side effects, and the deploy job queues. Also restrict the workflow to master, because the spec check always reads the master URL. Co-Authored-By: Claude Opus 5.5 <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
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
The Mintlify trigger ran on every merge and always passed, but docs often did not update. This PR fixes the two causes in this repo.
raw.githubusercontent.comsendscache-control: max-age=300, so the build could fetch a staleopenapi.yaml.openapi.yamlat the pushed commit.curlignored HTTP errors, and the job never checked the result. A bad token or a failed build still passed.--fail-with-body, require astatusId, then pollGET /v1/project/update-status/{statusId}untilsuccessorfailure. A failure prints the Mintlify summary and logs.Other changes:
wait-for-specwaits and checks the spec; a newer push cancels it, which is safe because nothing has gone to Mintlify yet.deploytriggers and polls; it queues and is never cancelled, so each Mintlify build finishes before the next one starts.workflow_dispatchlets you run the workflow by hand from the Actions tab. A manual run skips the wait. Both jobs run only onmaster, because the spec check always reads themasterURL.MINTLIFY_TOKENandMINTLIFY_PROJECT_IDsecrets. No new secrets.This PR does not make new endpoints appear. docs-core API pages are stubs, so each new endpoint also needs a stub page and a nav entry in docs-core (for example, Portkey-AI/docs-core#1098 for
/decisions).Test plan
bash -npasses on eachrunscriptgit show origin/master:openapi.yamland the raw URL have the same SHA-256masterwaits, triggers, and ends withMintlify status: successworkflow_dispatchrun onmasterskips the wait; a run on another branch skips both jobs🤖 Generated with Claude Code