Skip to content

Commit 1d32655

Browse files
authored
Update docs to show release policies and support (#1560)
1 parent 78c793a commit 1d32655

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

.bazelci/presubmit.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ tasks:
155155
bazel: "rolling"
156156
ubuntu1804:
157157
name: "Min Bazel Version"
158+
# If updating the minimum bazel version, please also update /docs/index.md
158159
bazel: "5.0.0"
159160
platform: ubuntu1804
160161
build_targets: *default_linux_targets

docs/index.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,7 @@ rules_rust_dependencies()
3636
rust_register_toolchains()
3737
```
3838

39-
The rules are under active development, as such the lastest commit on the
40-
`main` branch should be used. `main` is only tested against `5.0.0` as the
41-
minimum supported version of Bazel. Though previous versions may still be
42-
functional in certain environments.
39+
The rules are released, and releases can be found on [the GitHub Releases page](https://github.com/bazelbuild/rules_rust/releases). We recommend using the latest release from that page.
4340

4441
## Rules
4542

@@ -82,3 +79,17 @@ rust_register_toolchains(rustfmt_version = "1.62.1")
8279
## External Dependencies
8380

8481
[crate_universe](crate_universe.md) is a tool built into `rules_rust` that can be used to fetch dependencies. Additionally, [cargo-raze](https://github.com/google/cargo-raze) is an older third-party which can also fetch dependencies.
82+
83+
## Supported bazel versions
84+
85+
The oldest version of Bazel the `main` branch is tested against is `5.0.0`. Previous versions may still be functional in certain environments, but this is the minimum version we strive to fully support.
86+
87+
We test these rules against the latest rolling releases of Bazel, and aim for compatibility with them, but prioritise stable releases over rolling releases where necessary.
88+
89+
## Supported platforms
90+
91+
We aim to support Linux, macOS, and Windows.
92+
93+
Windows support is less complete than the other two platforms, but most things work, and we welcome contributions to help improve its support.
94+
95+
Windows support for some features requires `--enable_runfiles` to be passed to Bazel, we recommend putting it in your bazelrc. See [Using Bazel on Windows](https://bazel.build/configure/windows) for more Windows-specific recommendations.

0 commit comments

Comments
 (0)