Skip to content

Build the docs on pull requests - #525

Merged
dereuromark merged 1 commit into
masterfrom
ci/docs-build-on-pr
Nov 10, 2026
Merged

dereuromark merged 1 commit into
masterfrom
ci/docs-build-on-pr

Conversation

@dereuromark

@dereuromark dereuromark commented Nov 10, 2026 •

Copy link
Copy Markdown
Owner

The docs workflow only ran on push to the default branch, so a dependency bump that broke the docs build merged green and only failed after the merge. Pull requests that touch the docs now run the build too, while the Pages deploy steps stay push-only.

Summary by CodeRabbit

  • Chores
    • Changes to documentation or its deployment workflow now trigger a build on pull requests. Pull requests run the build without uploading or deploying the documentation; deployment remains separate.

The docs workflow only ran on push to the default branch, so a dependency bump that breaks the docs build merged green and only failed after merge. PRs touching the docs now run the build; deploy steps stay push-only.
@coderabbitai

coderabbitai Bot commented Nov 10, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation deployment workflow now runs for pull requests that change documentation or the workflow file. Pull-request runs use a ref-specific concurrency group and skip Pages setup, artifact upload, and deployment. The build job remains configured to run.

Changes: Documentation deployment workflow

Layer / File(s) Summary
Pull-request trigger and execution conditions
.github/workflows/deploy-docs.yml
The workflow runs for pull requests that change docs/** or .github/workflows/deploy-docs.yml. It uses a pull-request-ref concurrency group for pull requests and deploy for other events. Pull requests skip Pages setup, artifact upload, and deployment.

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Feature

Possibly related PRs

Suggested labels: feature

Merge Risk: Minimal · up to b872e

No actionable merge-blocking risk was identified for the documentation workflow.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly summarizes the main change: building documentation on pull requests.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 520be0d1-e935-4569-abc7-b3a72e881948
Commits

Reviewing files that changed from the base of the PR and between c8df1b0 and b872ec4.

Files selected for processing: 1

  • .github/workflows/deploy-docs.yml

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

@dereuromark
dereuromark merged commit 5149c6e into master Nov 10, 2026
21 checks passed
@dereuromark
dereuromark deleted the ci/docs-build-on-pr branch November 10, 2026 23:40
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