Better error messages for lockfile conflicts (#6489)

connortsui20 · web-flow · commit 66b85b7069c5 · 2026-02-13T12:10:25.000-05:00
A bit more verbose error messages for when the public API changes.

Signed-off-by: Connor Tsui &lt;connor.tsui20@gmail.com&gt;
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -348,8 +348,19 @@ jobs:
         run: bash scripts/public-api.sh
       - name: Verify lock files are up to date
         run: |
-          git diff --name-only
-          git diff --exit-code '**/public-api.lock'
+          if ! git diff --quiet '**/public-api.lock'; then
+            git diff -U0 '**/public-api.lock'
+            echo ""
+            echo ""
+            echo "Changed files:"
+            git diff --name-only '**/public-api.lock'
+            echo ""
+            echo ""
+            echo "Public API lock files are out of date."
+            echo "Run './scripts/public-api.sh' locally to"
+            echo "regenerate them, then commit the changes."
+            exit 1
+          fi
 
   rust-coverage:
     name: "Rust tests (coverage) (${{ matrix.suite }})"
diff --git a/scripts/public-api.sh b/scripts/public-api.sh
@@ -4,6 +4,27 @@
 
 set -Eeu -o pipefail
 
+if ! rustup run nightly rustc --version &>/dev/null; then
+    echo "Error: nightly toolchain is not installed."
+    echo "`cargo-public-api` requires nightly to build rustdoc JSON."
+    echo ""
+    echo "Install it with:"
+    echo "  rustup install nightly --profile minimal"
+    echo ""
+    echo "See https://crates.io/crates/cargo-public-api"
+    exit 1
+fi
+
+if ! cargo +nightly public-api --version &>/dev/null; then
+    echo "Error: `cargo-public-api` is not installed."
+    echo ""
+    echo "Install it with:"
+    echo "  cargo +stable install cargo-public-api --locked"
+    echo ""
+    echo "See https://crates.io/crates/cargo-public-api"
+    exit 1
+fi
+
 # Regenerate public-api.lock files for all published crates.
 # Uses cargo-public-api to dump the public API surface of each crate.
 #
