Skip to content

docs: fix docs/ci.md claiming a MacOS unit-test runner that doesn't exist - #713

Open
UgaTheDev wants to merge 1 commit into
instructlab:mainfrom
UgaTheDev:fix/unit-yaml-docs-mismatch
Open

docs: fix docs/ci.md claiming a MacOS unit-test runner that doesn't exist#713
UgaTheDev wants to merge 1 commit into
instructlab:mainfrom
UgaTheDev:fix/unit-yaml-docs-mismatch

Conversation

@UgaTheDev

Copy link
Copy Markdown

docs/ci.md says unit tests run "with Python 3.11 - 3.13 on Ubuntu and MacOS
runners." .github/workflows/unit.yaml's matrix is
platform: [ubuntu-latest] only — there is no macOS runner and never has
been in this workflow. This drops the false claim so the doc matches the
workflow it links to.

I considered the other direction — adding a real macos-latest leg to the
matrix — but that's a maintainer call (extra CI minutes/cost, and macOS
runners can behave differently for the CUDA-adjacent bits of this repo's
build), not something to sneak in as a docs fix. This PR only makes the doc
tell the truth about what CI already does; happy to help wire up an actual
macOS job in a separate PR if that's wanted.

Originally flagged in #705 (comment from 2026-07-29): "docs/ci.md claims unit tests run "with Python 3.11 - 3.13 on Ubuntu and MacOS runners". unit.yaml's matrix is platform: [ubuntu-latest], so there is no MacOS runner."

One-line diff, docs/ci.md only.

docs/ci.md claimed unit tests run 'with Python 3.11 - 3.13 on Ubuntu and
MacOS runners'. unit.yaml's matrix is platform: [ubuntu-latest] only;
there is no macOS runner. Fixes the doc to match the workflow it links
to. Adding an actual macOS leg is a separate, maintainer-level decision
(extra CI cost) and out of scope here.

Ref: instructlab#705

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Signed-off-by: Kush Zingade <kush.zingade@gmail.com>
@coderabbitai

coderabbitai Bot commented Aug 24, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 59 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 86223099-2925-4dcb-b31c-25c45528ff60

📥 Commits

Reviewing files that changed from the base of the PR and between da76404 and 79f3c79.

📒 Files selected for processing (1)
  • docs/ci.md

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

Comment @coderabbitai help to get the list of available commands.

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