Skip to content

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

Merged
merged 1 commit into from
May 9, 2025
Merged

CI: Remove building docs on macOS #201

merged 1 commit into from
May 9, 2025

Conversation

amotl
Copy link
Member

@amotl amotl commented May 9, 2025

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.

(integrate/langchain/index: line  141) broken    https://github.com/crate/cratedb-examples/blob/main/topic/machine-learning/llm-langchain/conversational_memory.ipynb -
429 Client Error: Too Many Requests for url: https://github.com/crate/cratedb-examples/blob/main/topic/machine-learning/llm-langchain/conversational_memory.ipynb

-- https://github.com/crate/cratedb-guide/actions/runs/14926973334/job/41933954698?pr=199#step:4:1689

References

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.
@amotl amotl requested review from bmunkholm and kneth May 9, 2025 10:44

This comment was marked as off-topic.

os: [ubuntu-latest, macos-latest]
os: [ubuntu-latest]
Copy link
Member Author

@amotl amotl May 9, 2025

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.

Copy link

@coderabbitai coderabbitai bot left a 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 the strategy/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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ebaa06 and 0bbf4e5.

📒 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.

Copy link
Contributor

@bmunkholm bmunkholm left a 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 :-)

@amotl
Copy link
Member Author

amotl commented May 9, 2025

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
crate-docs also here on downstream projects while it was still in flux, and also it might have made sense in previous eras because Sphinx might not always have been stable for macOS. We need to consider here that the whole operation started in Sphinx 1.x times already, around a decade ago.

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.

@amotl amotl mentioned this pull request May 9, 2025
@amotl amotl merged commit 5ddb267 into main May 9, 2025
3 checks passed
@amotl amotl deleted the ci-remove-macos branch May 9, 2025 10:55
@coderabbitai coderabbitai bot mentioned this pull request May 9, 2025
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.

2 participants