CI: Only build on Ubuntu.

[bmunkholm]

Summary of the changes / Why this is an improvement

Update CI recipe to align with others - primarily reducing build time.

[coderabbitai]

Walkthrough

The GitHub Actions workflow for building documentation was updated to allow manual triggering, removed the OS matrix to run only on Ubuntu, upgraded checkout and Python setup actions to newer versions, added pip caching, and made minor configuration adjustments. No changes were made to exported or public code entities.

Changes

File(s)	Change Summary
.github/workflows/docs.yml	Added manual trigger, removed OS matrix (runs only on Ubuntu), upgraded checkout and setup-python actions, enabled pip caching, and adjusted configuration details.

Poem

🐇
A workflow hops with lighter feet,
No more OSes to repeat.
With cache in tow and triggers new,
It builds our docs on Ubuntu too.
Actions upgraded, neat and bright—
Our docs now leap with all their might!

Tip

⚡️ Faster reviews with caching

• CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.

Enjoy the performance boost—your workflow just got faster.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

.github/workflows/docs.yml (2)

3-3: Review PR triggers for pull requests
The pull_request trigger is now unfiltered, so documentation builds will run on PRs from any branch. If you only want to build docs for PRs targeting main, consider adding:

on:
  pull_request:
    branches:
      - main

---

7-7: Remove trailing whitespace
Static analysis flags trailing spaces on these lines. Cleaning them up maintains YAML cleanliness and avoids linter errors.

Also applies to: 10-10, 32-32

🧰 Tools

🪛 YAMLlint (1.35.1)

[error] 7-7: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 70e415f and 6c58d57.

📒 Files selected for processing (1)

• .github/workflows/docs.yml (1 hunks)

🧰 Additional context used

🪛 YAMLlint (1.35.1)

.github/workflows/docs.yml

[error] 7-7: trailing spaces

(trailing-spaces)

---

[error] 10-10: trailing spaces

(trailing-spaces)

---

[error] 32-32: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Summary

🔇 Additional comments (4)

.github/workflows/docs.yml (4)

8-9: Add manual workflow dispatch
Great addition of the workflow_dispatch event, which allows ad-hoc/manual runs of the documentation build.

---

18-19: Restricting the job to Ubuntu
Switching to runs-on: ubuntu-latest aligns with other CI jobs and speeds up builds by dropping the matrix. Ensure there are no OS-specific dependencies in your docs build that require macOS before merging.

---

22-23: Upgrade checkout action to v4
Upgrading to actions/checkout@v4 (with a descriptive step name) is recommended for improved performance and features.

---

26-31: Enable Python setup caching
Using actions/setup-python@v5 with pip caching and a dependency path (docs/requirements.txt) is a solid optimization. Please verify that docs/requirements.txt exists and includes all necessary dependencies so the cache key works as intended.