chore: enhance test schema_is_up_to_date (#1285)

Co-authored-by: Marco Ieni <11428655+MarcoIeni@users.noreply.github.com>

Cargo.toml

@@ -26,6 +26,7 @@ ignore = "0.4.22"
 lazy_static = "1.4.0"
 once_cell = "1.19.0"
 parse-changelog = { version = "0.6.4", default-features = false }
+pretty_assertions = "1.4.0"
 rayon = "1.8.1"
 regex = "1.10.3"
 reqwest = "0.11.24"

crates/release_plz/Cargo.toml

@@ -54,6 +54,7 @@ assert_cmd.workspace = true
 async-trait.workspace = true
 fake.workspace = true
 expect-test.workspace = true
+pretty_assertions.workspace = true
 serde_json.workspace = true
 tempfile.workspace = true
 toml_edit.workspace = true

crates/release_plz/src/generate_schema.rs

@@ -37,6 +37,7 @@ fn generate_schema_json() -> anyhow::Result<String> {
 #[cfg(test)]
 mod tests {
     use crate::generate_schema::{generate_schema_json, FILE, FOLDER};
+    use pretty_assertions::assert_eq;
     use std::path::Path;
     use std::{env, fs};
 
@@ -65,7 +66,8 @@ mod tests {
         // Windows-friendly comparison
         assert_eq!(
             existing_json.replace("\r\n", "\n"),
-            new_json.replace("\r\n", "\n")
+            new_json.replace("\r\n", "\n"),
+            "(Hint: if change is intentional run `cargo run -- generate-schema` to update schema.)"
         );
     }
 }