-
Notifications
You must be signed in to change notification settings - Fork 1
CI: Remove building docs on macOS #201
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Those CI workflows' intentions are mostly to run the link checker, so it's not too much connected to covering operating systems. By removing the checks for macOS, the process will relax pressure on downstream resources, aiming for making it more unlikely to hit rate limiting measures.
This comment was marked as off-topic.
This comment was marked as off-topic.
os: [ubuntu-latest, macos-latest] | ||
os: [ubuntu-latest] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's please propagate this change also to other projects which are doing it the same way, in order to reduce overall HTTP resource consumption, effectively cutting it in half.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/workflows/docs.yml (1)
19-25
: Optional: simplify the workflow by removing the matrix.Since this job is only ever run on
ubuntu-latest
, you can drop thestrategy
/matrix
block and directly specify:jobs: documentation: name: Build docs runs-on: ubuntu-latest steps: …This will reduce YAML complexity and make future maintenance easier.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/docs.yml
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Build docs on ubuntu-latest
🔇 Additional comments (1)
.github/workflows/docs.yml (1)
22-25
: Approve removal of macOS from the docs job matrix.The matrix now only targets
ubuntu-latest
, which aligns perfectly with the PR objective of reducing CI load and avoiding rate limiting without impacting the link‐checker workflow.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was wondering wondering why we did this in the first place :-)
We just inherited this from previous generations of hackers. It might have made sense to integration-test things like Essential ingredients of the documentation stack are certainly more stable across operation systems today, so it will not be a huge loss to remove this slot from the test matrix. |
About
The CI workflows' intentions here are mostly to run the link checker, so it's not too much connected to covering operating systems.
By removing the checks for macOS, the process will relax pressure on downstream resources, aiming for making it more unlikely to hit rate limiting measures.
Details
It's not just rate limiting, it's also 429 Too Many Requests.
-- https://github.com/crate/cratedb-guide/actions/runs/14926973334/job/41933954698?pr=199#step:4:1689
References