Skip to content

Build the documentation site on pull requests - #1455

Merged
manuelmayer-dev merged 1 commit into
mainfrom
ci/build-docs-on-pull-requests
Oct 21, 2026
Merged

manuelmayer-dev merged 1 commit into
mainfrom
ci/build-docs-on-pull-requests

Conversation

@manuelmayer-dev

@manuelmayer-dev manuelmayer-dev commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Summary

The Docs workflow only ran on pushes to main, so a pull request that broke the documentation install or build showed all checks green and the failure surfaced only after merge. That is how #1443 broke main (fixed by #1453).

This adds a pull_request trigger with the same path filter as the push trigger, so the "Build documentation site" job runs on every PR that touches docs/, the SDK, the protocol, the UI model or the workflow itself. The deploy job stays gated on a manual workflow_dispatch run, and the build job uses no secrets, so PRs from Dependabot and forks run it safely.

Testing

  • The workflow file parses and lists workflow_dispatch, push and pull_request as triggers
  • This PR touches .github/workflows/docs.yml, so its own checks include the docs build

Notes

To block merges on it, "Build documentation site" still has to be added as a required check in the branch protection for main.

Checklist

  • Tests were added or updated where needed
  • The change was verified manually where appropriate
  • Documentation was updated if the change affects documented behaviour
  • I reviewed and understand every submitted change

@manuelmayer-dev
manuelmayer-dev merged commit b1b8a15 into main Oct 21, 2026
19 checks passed
@manuelmayer-dev
manuelmayer-dev deleted the ci/build-docs-on-pull-requests branch October 21, 2026 19:54
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.

1 participant