Repository navigation
Allow Publish Docs to be run manually - #1289
Merged
Merged
Conversation
The nightly update-openapi job auto-merges its spec PR with the built-in GITHUB_TOKEN, and GitHub does not start other workflows from events made with that token. So Publish Docs never runs for spec updates, and API reference changes stay unpublished until someone merges an unrelated PR. Add a workflow_dispatch trigger so the site can be republished on demand, and widen the job guard to accept it. Manual runs stay limited to main. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Lightsage docs evalsLightsage could not queue docs evals for this PR. Docs URL: https://vapi-preview-01a11282-fcaf-7058-9bfa-e62d76166d10.docs.buildwithfern.com |
stephenvapiai
approved these changes
Oct 6, 2026
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a11282-fcaf-7058-9bfa-e62d76166d10.docs.buildwithfern.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
Adds a manual trigger (
workflow_dispatch) to Publish Docs, so docs.vapi.ai can be republished from the Actions tab or the CLI without merging a PR.Why
The nightly
update-openapijob auto-merges its spec PR with the built-inGITHUB_TOKEN. GitHub doesn't start other workflows from events made with that token, so Publish Docs never runs for spec updates. New API fields therefore don't reach the live API reference until someone merges an unrelated docs PR.Example: voice simulation latency expectations shipped on Oct 3. The spec updates that added the fields merged in #1284 (Oct 3) and #1286 (Oct 6), but the last publish ran on Oct 2, so the live Create and Update Scenario pages still don't show
latencyExpectations.Change
Two lines in
.github/workflows/publish-docs.yml:workflow_dispatch:underon:;if:guard to acceptworkflow_dispatchas well aspush. Without this, a manual run would show as skipped. The guard also now checksgithub.ref == 'refs/heads/main'exactly instead ofcontains(...), so a manual run can't publish another branch.The publish steps and secrets are unchanged.
Using it
Once merged, anyone with write access can run Actions → Publish Docs → Run workflow on
main, or:Merging this PR also publishes everything pending on
main, including the latest API spec.Not included
This makes publishing possible on demand but doesn't make it automatic after the nightly spec update. Two options for the docs owners:
GITHUB_TOKEN, so the merge triggers Publish Docs;schedule:to this workflow shortly after the nightly update.Testing
actionlintv1.7.7 passes with no findings, and the YAML parses with both triggers. A manual trigger can only be exercised once it's onmain, so the first real test is a manual run after merge.🤖 Generated with Claude Code