Skip to content

Allow Publish Docs to be run manually - #1289

Merged
scott-lowe-vapi merged 1 commit into
mainfrom
scottlowe/publish-docs-manual-trigger
Oct 6, 2026
Merged

scott-lowe-vapi merged 1 commit into
mainfrom
scottlowe/publish-docs-manual-trigger

Conversation

@scott-lowe-vapi

Copy link
Copy Markdown
Contributor

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-openapi job auto-merges its spec PR with the built-in GITHUB_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:

  • add workflow_dispatch: under on:;
  • widen the job's if: guard to accept workflow_dispatch as well as push. Without this, a manual run would show as skipped. The guard also now checks github.ref == 'refs/heads/main' exactly instead of contains(...), 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:

gh workflow run publish-docs.yml --repo VapiAI/docs --ref main

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:

  • merge the nightly PR with a GitHub App or bot account token instead of GITHUB_TOKEN, so the merge triggers Publish Docs;
  • or add a schedule: to this workflow shortly after the nightly update.

Testing

actionlint v1.7.7 passes with no findings, and the YAML parses with both triggers. A manual trigger can only be exercised once it's on main, so the first real test is a manual run after merge.

🤖 Generated with Claude Code

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-app

lightsage-app Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Lightsage docs evals

Lightsage could not queue docs evals for this PR.

Docs URL: https://vapi-preview-01a11282-fcaf-7058-9bfa-e62d76166d10.docs.buildwithfern.com
Commit: b793b2c
Reason: No custom evals are selected for GitHub PR evals. Open Lightsage > Custom Evals and enable the GitHub checkbox for at least one custom eval.

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

@scott-lowe-vapi
scott-lowe-vapi merged commit dec5826 into main Oct 6, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants