From 86b1f071f8763e4d8fde781518906817f41f576b Mon Sep 17 00:00:00 2001 From: Kaur Kuut Date: Fri, 19 Apr 2024 16:05:07 +0300 Subject: [PATCH] Add note about MSRV compile failure. (#35) * Add note about MSRV compile failure. * Bump MSRV to 1.74 due to `clap_derive` v4.5.4. --- .github/workflows/ci.yml | 2 +- Cargo.toml | 2 +- README.md | 14 +++++++++++++- 3 files changed, 15 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 63936e4d..2b67525c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,7 +8,7 @@ env: # If the compilation fails, then the version specified here needs to be bumped up to reality. # Be sure to also update the rust-version property in the workspace Cargo.toml file, # plus all the README.md files of the affected packages. - RUST_MIN_VER: "1.70" + RUST_MIN_VER: "1.74" # List of packages that will be checked with the minimum supported Rust version. # This should be limited to packages that are intended for publishing. RUST_MIN_VER_PKGS: "-p parley" diff --git a/Cargo.toml b/Cargo.toml index 6c68c764..13768230 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Chad Brokaw "] license = "Apache-2.0 OR MIT" edition = "2021" # Keep in sync with RUST_MIN_VER in .github/workflows/ci.yml and with the relevant README.md files. -rust-version = "1.70" +rust-version = "1.74" [features] default = ["system"] diff --git a/README.md b/README.md index 776fd7af..33b5330e 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,23 @@ It is backed by [Swash](https://github.com/dfrg/swash). ## Minimum supported Rust Version (MSRV) -This version of Parley has been verified to compile with **Rust 1.70** and later. +This version of Parley has been verified to compile with **Rust 1.74** and later. Future versions of Parley might increase the Rust version requirement. It will not be treated as a breaking change and as such can even happen with small patch releases. +
+Click here if compiling fails. + +As time has passed, some of Parley's dependencies could have released versions with a higher Rust requirement. +If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency. + +```sh +# Use the problematic dependency's name and version +cargo update -p package_name --precise 0.1.1 +``` +
+ ## Community Discussion of Parley development happens in the [Linebender Zulip](https://xi.zulipchat.com/), specifically the [#text stream](https://xi.zulipchat.com/#narrow/stream/205635-text).