[nextest-metadata] flesh out stability policy, prepare to make new release

Author: sunshowers

Cargo.lock

@@ -24,7 +24,7 @@ env_logger = { version = "0.9.0", default-features = false }
 guppy = "0.13.0"
 log = "0.4.14"
 nextest-runner = { version = "0.4.0", path = "../nextest-runner" }
-nextest-metadata = { version = "0.2.0", path = "../nextest-metadata" }
+nextest-metadata = { version = "0.2.1", path = "../nextest-metadata" }
 owo-colors = { version = "3.2.0", features = ["supports-colors"] }
 shellwords = "1.1.0"
 supports-color = "1.3.0"

cargo-nextest/Cargo.toml

@@ -1,5 +1,9 @@
 # Changelog
 
+## [0.2.1] - 2022-03-09
+
+Add documentation about nextest-metadata's "minimum supported cargo-nextest version".
+
 ## [0.2.0] - 2022-03-07
 
 Thanks to [Guiguiprim](https://github.com/Guiguiprim) for their contributions to this release!

nextest-metadata/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "nextest-metadata"
-version = "0.2.0"
+version = "0.2.1"
 description = "Structured access to nextest machine-readable output."
 license = "MIT OR Apache-2.0"
 edition = "2018"

nextest-metadata/Cargo.toml

@@ -37,6 +37,12 @@ The minimum supported Rust version is **Rust 1.54.**
 While this crate is a pre-release (0.x.x) it may have its MSRV bumped in a patch release.
 Once a crate has reached 1.x, any MSRV bump will be accompanied with a new minor version.
 
+## Minimum supported cargo-nextest version
+
+The "minimum supported cargo-nextest version" is **cargo-nextest 0.9.10**.
+
+For more about nextest-metadata's stability policy, see the [Stability
+page](https://nexte.st/book/stability#nextest-metadata) on the nextest site.
 
 ## Contributing
 

nextest-metadata/README.md

@@ -31,6 +31,12 @@
 //! While this crate is a pre-release (0.x.x) it may have its MSRV bumped in a patch release.
 //! Once a crate has reached 1.x, any MSRV bump will be accompanied with a new minor version.
 //!
+//! # Minimum supported cargo-nextest version
+//!
+//! The "minimum supported cargo-nextest version" is **cargo-nextest 0.9.10**.
+//!
+//! For more about nextest-metadata's stability policy, see the [Stability
+//! page](https://nexte.st/book/stability#nextest-metadata) on the nextest site.
 #![warn(missing_docs)]
 
 mod errors;

nextest-metadata/src/lib.rs

@@ -38,7 +38,7 @@ target-spec = "1.0"
 toml = "0.5.8"
 twox-hash = { version = "1.6.2", default-features = false }
 
-nextest-metadata = { version = "0.2.0", path = "../nextest-metadata" }
+nextest-metadata = { version = "0.2.1", path = "../nextest-metadata" }
 quick-junit = { version = "0.1.5", path = "../quick-junit" }
 
 [dev-dependencies]

nextest-runner/Cargo.toml

@@ -27,7 +27,9 @@ nextest-metadata contains data structures for deserializing cargo-nextest's [mac
 
 However, currently, **nextest-metadata is not backwards-compatible**: a new version of nextest-metadata may not be able to parse metadata generated by older versions of cargo-nextest. In other words, each version of nextest-metadata has a minimum supported cargo-nextest version, analogous to a crate's [minimum supported Rust version (MSRV)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html).
 
-(This policy may be relaxed in the future based on user needs.)
+A bump to the minimum supported cargo-nextest version is considered a breaking change, and will be paired with a major version bump.
+
+(The policy around backwards compatibility may be relaxed in the future based on user needs.)
 
 ### nextest-runner