Merge rust-bitcoin/rust-secp256k1#691: Check for API changes in CI

65d54e7bbeec41f2c61e61581a78758240e58dec Add script to update-lock-files (Tobin C. Harding)
c61db1b44f690901335db479f1f85eb745102641 CI: Check for API changes (Tobin C. Harding)
53d34d5ee0a89a4a41b17db7e3aa31d39db57d72 Update the API files (Tobin C. Harding)
c3f2c59db1f681d3770425d5f43483901545ca78 just: Add a command to check for API changes (Tobin C. Harding)
1e22d74270b357566ef266b790635ce6319dc569 Add a justfile (Tobin C. Harding)

Pull request description:

  This PR is not just CI, it does a few clean up chores:
  - Add a `justfile` (including command to check the API)
  - Update the API files
  - Add a script to update the lock files

ACKs for top commit:
  apoelstra:
    ACK 65d54e7bbeec41f2c61e61581a78758240e58dec

Tree-SHA512: c799200dc761cb4367904346024834caf52e9a549aed5741263429d0bd297858c5293bfdb4bdf83fffb063060f7f251c9c1956659bd50867b09fafddb3c54880

Author: chain-forgexcr45

.github/workflows/rust.yml

@@ -116,3 +116,18 @@ jobs:
         env:
           DO_WASM: true
         run: ./contrib/test.sh
+
+  API:
+    name: Check for changes to the public API
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - name: Checkout Crate
+        uses: actions/checkout@v3
+      - name: Checkout Toolchain
+        uses: dtolnay/rust-toolchain@nightly
+      - name: Install cargo-public-api
+        run: cargo install --locked cargo-public-api
+      - name: Running API checker script
+        run: ./contrib/check-for-api-changes.sh

api/all-features.txt

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+#
+# Update the minimal/recent lock file
+
+set -euo pipefail
+
+for file in Cargo-minimal.lock Cargo-recent.lock; do
+    cp --force "$file" Cargo.lock
+    cargo check
+    cp --force Cargo.lock "$file"
+done

api/alloc.txt

@@ -0,0 +1,38 @@
+default:
+  @just --list
+
+# Cargo build everything.
+build:
+  cargo build --all-targets --all-features
+
+# Cargo check everything.
+check:
+  cargo check --all-targets --all-features
+
+# Lint everything.
+lint:
+  cargo clippy --all-targets --all-features -- --deny warnings
+
+# Check the formatting
+format:
+  cargo +nightly fmt --check
+
+# Quick and dirty CI useful for pre-push checks.
+sane: lint
+  cargo test --quiet --all-targets --no-default-features > /dev/null || exit 1
+  cargo test --quiet --all-targets > /dev/null || exit 1
+  cargo test --quiet --all-targets --all-features > /dev/null || exit 1
+
+  # doctests don't get run from workspace root with `cargo test`.
+  cargo test --quiet --doc || exit 1
+
+  # Make an attempt to catch feature gate problems in doctests
+  cargo test --manifest-path Cargo.toml --doc --no-default-features > /dev/null || exit 1
+
+# Check for API changes.
+check-api:
+  ./contrib/check-for-api-changes.sh
+
+# Update the lock files.
+update-lock-files:
+  ./contrib/update-lock-files.sh