Repository navigation
Build the documentation site on pull requests - #1455
Merged
Merged
Conversation
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 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
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