Skip to content

Commit 183d297

Browse files
authored
doc: better document supported platform tiers (#2783)
Fixes #2722. Related #2734, #2276, #1579
1 parent d0950c5 commit 183d297

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

docs/support.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,35 @@ minor/patch versions.
3131
See [Bazel's release support matrix](https://bazel.build/release#support-matrix)
3232
for what versions are the rolling, active, and prior releases.
3333

34+
## Supported Python versions
35+
36+
As a general rule we test all released non-EOL Python versions. Different
37+
interpreter versions may work but are not guaranteed. We are interested in
38+
staying compatible with upcoming unreleased versions, so if you see that things
39+
stop working, please create tickets or, more preferably, pull requests.
40+
3441
## Supported Platforms
3542

3643
We only support the platforms that our continuous integration jobs run, which
37-
is Linux, Mac, and Windows. Code to support other platforms is allowed, but
38-
can only be on a best-effort basis.
44+
is Linux, Mac, and Windows.
45+
46+
In order to better describe different support levels, the below acts as a rough
47+
guideline for different platform tiers:
48+
* Tier 0 - The platforms that our CI runs: `linux_x86_64`, `osx_x86_64`, `RBE linux_x86_64`.
49+
* Tier 1 - The platforms that are similar enough to what the CI runs: `linux_aarch64`, `osx_arm64`.
50+
What is more, `windows_x86_64` is in this list as we run tests in CI but
51+
developing for Windows is more challenging and features may come later to
52+
this platform.
53+
* Tier 2 - The rest of the platforms that may have varying level of support, e.g.
54+
`linux_s390x`, `linux_ppc64le`, `windows_arm64`.
55+
56+
:::{note}
57+
Code to support Tier 2 platforms is allowed, but regressions will be fixed on a
58+
best-effort basis, so feel free to contribute by creating PRs.
59+
60+
If you would like to provide/sponsor CI setup for a platform that is not Tier 0,
61+
please create a ticket or contact the maintainers on Slack.
62+
:::
3963

4064
## Compatibility Policy
4165

0 commit comments

Comments
 (0)