Skip to content

Commit a9f82e6

Browse files
authored
Add a MSRV policy (#229)
And exclude Orbital from it as it requires nightly anyway.
1 parent 701026d commit a9f82e6

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

.github/workflows/ci.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ jobs:
4949
- { target: x86_64-unknown-netbsd, os: ubuntu-latest, options: --no-default-features, features: "x11,x11-dlopen,wayland,wayland-dlopen" }
5050
- { target: x86_64-apple-darwin, os: macos-latest, }
5151
- { target: wasm32-unknown-unknown, os: ubuntu-latest, }
52+
exclude:
53+
# Orbital doesn't follow MSRV
54+
- rust_version: '1.70.0'
55+
platform: { target: x86_64-unknown-redox, os: ubuntu-latest }
5256
include:
5357
- rust_version: nightly
5458
platform: { target: wasm32-unknown-unknown, os: ubuntu-latest, options: "-Zbuild-std=panic_abort,std", rustflags: "-Ctarget-feature=+atomics,+bulk-memory" }
@@ -90,7 +94,6 @@ jobs:
9094
run: |
9195
cargo update -p ahash --precise 0.8.7
9296
cargo update -p bumpalo --precise 3.14.0
93-
cargo update -p redox_syscall@0.5.3 --precise 0.5.2
9497
9598
- name: Build crate
9699
shell: bash

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,31 @@ fn main() {
128128
}
129129
```
130130

131+
MSRV Policy
132+
==
133+
This crate's Minimum Supported Rust Version (MSRV) is **1.70**. Changes to
134+
the MSRV will be accompanied by a minor version bump.
135+
136+
As a **tentative** policy, the upper bound of the MSRV is given by the following
137+
formula:
138+
139+
```text
140+
min(sid, stable - 3)
141+
```
142+
143+
Where `sid` is the current version of `rustc` provided by [Debian Sid], and
144+
`stable` is the latest stable version of Rust. This bound may be broken in case of a major ecosystem shift or a security vulnerability.
145+
146+
[Debian Sid]: https://packages.debian.org/sid/rustc
147+
148+
Orbital is not covered by this MSRV policy, as it requires a Rust nightly
149+
toolchain to compile.
150+
151+
All crates in the [`rust-windowing`] organizations have the
152+
same MSRV policy.
153+
154+
[`rust-windowing`]: https://github.com/rust-windowing
155+
131156
Changelog
132157
---------
133158

0 commit comments

Comments
 (0)