Skip to content

Commit

Permalink
Add note about MSRV compile failure. (#35)
Browse files Browse the repository at this point in the history
* Add note about MSRV compile failure.

* Bump MSRV to 1.74 due to `clap_derive` v4.5.4.
  • Loading branch information
xStrom authored Apr 19, 2024
1 parent 4f05e18 commit 86b1f07
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ authors = ["Chad Brokaw <[email protected]>"]
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"]
Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<details>
<summary>Click here if compiling fails.</summary>

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
```
</details>

## 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).
Expand Down

0 comments on commit 86b1f07

Please sign in to comment.