Skip to content

Build the docs on pull requests - #22

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
    • Documentation-related pull requests now run the documentation workflow.
    • Pull requests do not upload deployment artifacts or deploy the site; existing build steps still run.
    • Workflow runs for pull requests and deployments use separate concurrency groups, preventing them from sharing the same group.

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 requests use a ref-specific concurrency group and skip artifact upload and deployment.

Changes: Documentation deployment workflow

Layer / File(s) Summary
Pull-request workflow behavior
.github/workflows/deploy-docs.yml
The workflow runs for pull requests that change docs/** or the workflow file. It uses a ref-specific concurrency group for pull requests and skips artifact upload and deployment for those events.

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

Change: Feature

Merge Risk: Minimal · up to 47245

No actionable merge-blocking risk was identified.

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: the docs build now runs 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: 717604cf-1ed6-42bd-a2ac-2f59d86b2c1b
Commits

Reviewing files that changed from the base of the PR and between ea3f796 and 472458a.

Files selected for processing: 1

  • .github/workflows/deploy-docs.yml

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

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