Skip to content

ci: run the required docs checks on every pull request - #1405

Open
sonukapoor wants to merge 1 commit into
mainfrom
bugfix/issue-1404-docs-checks-on-every-pr
Open

sonukapoor wants to merge 1 commit into
mainfrom
bugfix/issue-1404-docs-checks-on-every-pr

Conversation

@sonukapoor

Copy link
Copy Markdown
Collaborator

Two of the five checks branch protection requires come from the docs workflow, and that workflow only ran when a pull request touched website/. So a pull request that changed only source code never got those two checks, could never satisfy protection, and every merge went through the admin override, which skips all five checks rather than just the two that could not run.

The workflow now runs on every pull request. A first job works out whether anything under website/, or this workflow itself, changed. When nothing did, Build Docusaurus site passes without installing or building, so the required check exists and says plainly that there was nothing to build. Website pull requests build exactly as before, and a broken build still fails. Pushes to main keep the path filter, so a source-only merge still does not redeploy the site.

The shared pages concurrency group, along with the pages: write and id-token: write permissions, now belongs to the deploy job alone. Pull request runs get a group of their own, so website pull requests opened close together stop replacing each other's pending run, which is how #1369 got stuck.

No branch protection setting changes. This pull request edits the workflow, so it gets a real site build itself; the first source-only pull request after it merges is the check of the other half.

Closes #1404

Two of the five required checks come from the docs workflow, which only
ran when a pull request touched website/. A source-only pull request
therefore never got them, so every merge went through the admin
override, which skips all five checks.

The workflow now runs on every pull request. A first job decides whether
website/ or this workflow changed, and when nothing did the build job
passes without installing or building. Pushes to main keep the path
filter, so a source-only merge still does not redeploy.

The pages concurrency group and the pages and id-token permissions now
apply to the deploy job only. Pull request runs get a group per pull
request, so website pull requests opened close together no longer
replace each other's pending run.

Closes #1404

This branch has not been deployed

No deployments
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.

ci: required website checks never run on source-only pull requests, so every merge needs the admin override

1 participant