Doc: Add document for supported macos versions #390
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
WalkthroughUpdated the macOS CGO deployment target in the Makefile from 11.0 to 13.0 and added Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Areas to check:
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
doc/supported_platforms.md (1)
11-11: Wrap the bare URL in Markdown link syntax.We run markdownlint (MD034), so please enclose the runner changelog URL in link syntax to avoid the lint warning.
-**macOS 13.0** may work but is not officially supported. Integration tests currently run on macOS 13, but this GitHub Actions runner will be deprecated soon. See: https://github.blog/changelog/2025-07-11-upcoming-changes-to-macos-hosted-runners-macos-latest-migration-and-xcode-support-policy-updates/#macos-13-is-closing-down +**macOS 13.0** may work but is not officially supported. Integration tests currently run on macOS 13, but this GitHub Actions runner will be deprecated soon. See [GitHub’s announcement](https://github.blog/changelog/2025-07-11-upcoming-changes-to-macos-hosted-runners-macos-latest-migration-and-xcode-support-policy-updates/#macos-13-is-closing-down).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
Makefile(1 hunks)doc/supported_platforms.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/supported_platforms.md
[grammar] ~7-~7: There might be a mistake here.
Context: ...ended and fully supported. CI tested on: - macOS 14 (Sonoma) - CI tested on Apple S...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...14 (Sonoma) - CI tested on Apple Silicon - macOS 15 (Sequoia) - CI tested on Apple ...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...cos-13-is-closing-down Architectures: - Intel x86_64 - Apple Silicon ## Limitat...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...-down Architectures: - Intel x86_64 - Apple Silicon ## Limitations - **Raw b...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.18.1)
doc/supported_platforms.md
11-11: Bare URL used
(MD034, no-bare-urls)
vyasgun
force-pushed
the
pr/docs/supported-macos
branch
from
72e2c7c to
3f5c582
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
doc/supported_platforms.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/supported_platforms.md
[grammar] ~7-~7: There might be a mistake here.
Context: ...ended and fully supported. CI tested on: - macOS 14 (Sonoma) - CI tested on Apple S...
(QB_NEW_EN)
[grammar] ~8-~8: There might be a mistake here.
Context: ...14 (Sonoma) - CI tested on Apple Silicon - macOS 15 (Sequoia) - CI tested on Apple ...
(QB_NEW_EN)
[grammar] ~13-~13: There might be a mistake here.
Context: ...s-13-is-closing-down). Architectures: - Intel x86_64 - Apple Silicon ## Limitat...
(QB_NEW_EN)
[grammar] ~14-~14: There might be a mistake here.
Context: ...own). Architectures: - Intel x86_64 - Apple Silicon ## Limitations - **Raw b...
(QB_NEW_EN)
vyasgun
force-pushed
the
pr/docs/supported-macos
branch
3 times, most recently
from
bad7ab4 to
869f730
Compare
doc/supported_platforms.md
Outdated
|
|
||
| ## Limitations | ||
|
|
||
| - **Raw block devices**: Using raw block devices like `/dev/disk1` requires macOS 14+. See Apple's [VZDiskBlockDeviceStorageDeviceAttachment](https://developer.apple.com/documentation/virtualization/vzdiskblockdevicestoragedeviceattachment) documentation. |
There was a problem hiding this comment.
I don’t think we should list these limitations here, gpu support is also macOS 14+, nested virt is macOS 15+, …
We can remove this section and list the limitation in the cmd line options documentation for example.
There was a problem hiding this comment.
ah okay, makes sense. I'll remove this section.
| - **macOS 13.0** may work but is not officially supported. Integration tests currently run on macOS 13, but this GitHub Actions runner will be deprecated soon. See [GitHub’s announcement](https://github.blog/changelog/2025-07-11-upcoming-changes-to-macos-hosted-runners-macos-latest-migration-and-xcode-support-policy-updates/#macos-13-is-closing-down). | ||
|
|
||
| **Architectures:** | ||
| - Intel x86_64 |
There was a problem hiding this comment.
Need to decide if we want to start deprecating this, or if we wait for apple to officialy drop support.
Just food for thought, no changes needed in this PR.
vyasgun
force-pushed
the
pr/docs/supported-macos
branch
from
869f730 to
c7ba078
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
doc/supported_platforms.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
doc/supported_platforms.md
[grammar] ~9-~9: There might be a mistake here.
Context: ...ended and fully supported. CI tested on: - macOS 14 (Sonoma) - CI tested on Apple S...
(QB_NEW_EN)
[grammar] ~10-~10: There might be a mistake here.
Context: ...14 (Sonoma) - CI tested on Apple Silicon - macOS 15 (Sequoia) - CI tested on Apple ...
(QB_NEW_EN)
[grammar] ~11-~11: There might be a mistake here.
Context: ...5 (Sequoia) - CI tested on Apple Silicon - macOS 26 (Tahoe) - CI tested on Apple Si...
(QB_NEW_EN)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build (macos-15)
- GitHub Check: build (macos-14)
- GitHub Check: lint
doc/supported_platforms.md
Outdated
| The project aims to support the most recent macOS major version at all times, along with the two previous major versions. Support for the oldest supported version will be dropped three years after its release date or when Apple discontinues support, whichever occurs first. | ||
|
|
||
| **macOS 14.0 or later** is recommended and fully supported. CI tested on: | ||
| - macOS 14 (Sonoma) - CI tested on Apple Silicon |
There was a problem hiding this comment.
We don’t really test Apple silicon in CI, apart from some non-virt unit tests, which I would not call "testing" :)
Imo, we can drop all explicit versions from this file, this way we don’t need to update it next year when 27 is released.
doc/supported_platforms.md
Outdated
| - macOS 15 (Sequoia) - CI tested on Apple Silicon | ||
| - macOS 26 (Tahoe) - CI tested on Apple Silicon | ||
|
|
||
| - **macOS 13.0** may work but is not officially supported. Integration tests currently run on macOS 13, but this GitHub Actions runner will be deprecated soon. See [GitHub’s announcement](https://github.blog/changelog/2025-07-11-upcoming-changes-to-macos-hosted-runners-macos-latest-migration-and-xcode-support-policy-updates/#macos-13-is-closing-down). |
There was a problem hiding this comment.
Despite what I said above, we can keep this one for now.
There was a problem hiding this comment.
I replaced this with macos-15-intel deprecation information.
vyasgun
force-pushed
the
pr/docs/supported-macos
branch
from
c7ba078 to
a6a66d4
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
doc/supported_platforms.md (1)
19-19: Wrap bare URL in markdown link syntax.The URL at line 19 is not wrapped in markdown formatting. Convert it to a proper link using
[description](url)syntax to improve readability and consistency with documentation best practices.Apply this diff:
- Integration tests with virtualization are run on **macos-15-intel** runners, as virtualization is not supported on Apple Silicon runners in GitHub Actions. These Intel runners will be deprecated by August 2027. See: https://github.com/actions/runner-images/issues/13045 + Integration tests with virtualization are run on **macos-15-intel** runners, as virtualization is not supported on Apple Silicon runners in GitHub Actions. These Intel runners will be deprecated by August 2027. See: [actions/runner-images#13045](https://github.com/actions/runner-images/issues/13045)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
Makefile(1 hunks)doc/supported_platforms.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- Makefile
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-03T11:24:48.305Z
Learnt from: vyasgun
Repo: crc-org/vfkit PR: 376
File: .github/workflows/compile.yml:30-34
Timestamp: 2025-10-03T11:24:48.305Z
Learning: macos-15-intel and macos-26 are valid GitHub-hosted runner labels available in 2025. macos-15-intel is an Intel x86_64 runner, and macos-26 is an arm64 runner in public preview. If actionlint flags them as unknown, whitelist them in .github/actionlint.yaml under self-hosted-runner.labels.
Applied to files:
doc/supported_platforms.md
🪛 markdownlint-cli2 (0.18.1)
doc/supported_platforms.md
19-19: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build (macos-15)
- GitHub Check: build (macos-26)
- GitHub Check: build (macos-14)
- GitHub Check: build (macos-15-intel)
- GitHub Check: lint
🔇 Additional comments (1)
doc/supported_platforms.md (1)
7-19: Content is accurate and well-structured.macOS 26 (Tahoe) is confirmed as the current macOS major release, announced at WWDC 2025 and released September 15, 2025. The macOS 26 image is available on GitHub Actions arm64 runners, making the CI testing configurations listed in line 17 correct and up-to-date.
The Host Requirements policy (line 7) clearly articulates support for the latest 3 major versions with a 3-year deprecation window, which aligns with industry practice and the linked issue objectives.
vyasgun
force-pushed
the
pr/docs/supported-macos
branch
from
a6a66d4 to
9dbe7ef
Compare
2 participants
Fixes: #378
Summary by CodeRabbit