Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rust-version in Cargo.toml #60

Merged
merged 1 commit into from
Sep 18, 2023
Merged

Conversation

cgwalters
Copy link
Contributor

cc #59

This is the standard way to encode MSRV and in the future may be read by more tooling.

@cgwalters cgwalters mentioned this pull request Sep 18, 2023
README.md Outdated
@@ -20,10 +20,6 @@ if let Some((Width(w), Height(h))) = size {
}
```

## Minimum Rust Version

This crate requires a minimum rust version of 1.63.0 (2022-08-11)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without additional scripting, there's not an easy way to duplicate this in the README.md. I'd argue it's not necessarily and anyone interested will hopefully now know to look for rust-version.

That said...it seems to me that crates.io, lib.rs and docs.rs etc. should render this in their HTML views too.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I keep my MSRV to a schedule and use renovatebot to update it: https://github.com/clap-rs/clap/blob/master/.github/renovate.json5#L29

The problem I've found is if you don't do this,

  • people will assume your MSRV is something it isn't
  • contributors will be shy about doing or asking for MSRV bumps

Alternatively, before I had that tool, I had a tag in every location for updating it (effectively what I match the regex on now).

One way to keep CI in sync is if you use cargo hack <cmd> --rust-version.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestions, thanks

README.md Outdated Show resolved Hide resolved
cc eminence#59

This is the standard way to encode MSRV and in the future
may be read by more tooling.
@eminence eminence merged commit b15c997 into eminence:master Sep 18, 2023
17 checks passed
@eminence
Copy link
Owner

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants