summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNora Widdecke <nora@sequoia-pgp.org>2022-10-13 17:26:56 +0200
committerNora Widdecke <nora@sequoia-pgp.org>2022-10-18 11:04:43 +0200
commit8696501c12300e9d1781e75f7ff423e60eeffe41 (patch)
treea4e9d7a54267f5f6bde202b41b1db5481714dea7
parent050fa88086904993bb133e963a6ba328f138e812 (diff)
Document how to update MSRV.
-rw-r--r--doc/msrv.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/msrv.md b/doc/msrv.md
new file mode 100644
index 00000000..1a69304a
--- /dev/null
+++ b/doc/msrv.md
@@ -0,0 +1,12 @@
+How to update the MSRV
+
+1. set the new version in `<crate>/Cargo.toml` (or all `<crate>/Cargo.toml`s)
+1. set the new version in `clippy.toml`
+1. run `cargo build` and check if eveything still works
+1. run `cargo clippy` and apply the new lints, or ignore them in `.cargo/config`
+1. update the readmes
+ - README.md and openpgp/README.md, possibly more in the future
+ - grep for the version number, e.g. "1.60.0"
+1. update CI
+ - some jobs require explicit installation of the correct toolchain, grep for
+ the version number to find them.