[Crate] Add documentation for where versions need to be updated (#58)

VERSIONS.md tells you what the current versions for things like MSRV is
and which files you need to update if you change it.

Also fixes the incorrect:
- MSRV in README.md
- nightly version in .pre-commit-config.yaml
This commit is contained in:
Tom 2023-06-25 13:02:25 +00:00 committed by GitHub
parent 9c93e40650
commit bf14ecb4a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 3 deletions

26
VERSIONS.md Normal file
View file

@ -0,0 +1,26 @@
# MSRV (Minimum Supported Rust Version)
Current: `1.60.0`
Places to update:
- `Cargo.toml`
- `README.md`
- `.github/workflows/ci.yml`
# rustfmt version
Current: `1.5.2`
Places to update:
- `.rustfmt.toml`
- The nightly rust version
# The nightly rust version
The toolchain version used to run rustfmt in CI
Current: `nightly-2023-03-01`
Places to update:
- `./.github/workflows/ci.yml`
- `./.pre-commit-config.yaml`