Skip to content

ci: block PR merge on a broken docs-site build - #495

Merged
joshua-temple merged 1 commit into
mainfrom
ci/docs-build-gate
Jul 6, 2026
Merged

joshua-temple merged 1 commit into
mainfrom
ci/docs-build-gate

Conversation

@joshua-temple

Copy link
Copy Markdown
Collaborator

Problem

The docs site build ran on PRs (in docs-deploy.yaml) but its result could not block a merge: it lives in a separate workflow, and cross-workflow needs is impossible, so a broken Astro build could still merge. Making a path-filtered docs check required directly would deadlock non-docs PRs, which never report that status.

Fix

  • Add a skip-tolerant docs-build job to pr.yaml, gated on a docs path filter, and wire it into the already-required PR Gate. Non-docs PRs skip it and the gate stays skip-tolerant, so no deadlock. A failing docs build now fails the gate and blocks the merge.
  • Make docs-deploy.yaml push-only so the PR-time build is not duplicated; PR-time build validation now lives in the gate. The build and deploy jobs are otherwise unchanged.

Verification

  • actionlint clean on both workflow files.
  • npm ci + npm run build succeed in docs/ under Node 22 (23 pages built), proving the new gate job's commands.

Wire a skip-tolerant docs-build job into the already-required PR Gate so a failing Astro build blocks the merge, gated on a docs path filter so non-docs PRs skip it and do not deadlock. Make docs-deploy push-only now that PR-time build validation lives in the gate.

Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
@joshua-temple
joshua-temple merged commit f697532 into main Jul 6, 2026
16 checks passed
@joshua-temple
joshua-temple deleted the ci/docs-build-gate branch July 6, 2026 18:44
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