Merge rust-bitcoin#5158: Add maintainer-tools support to the justfile

74052cd Add maintainer-tools support to the justfile (Nick Johnson)

Pull request description:

  Testing the waters here a bit to see if this is a pain point for others. Happy to iterate on it in the background and prioritize other things.
  
  The justfile is a nice interface for local development, but ideally its logic is the exact same as what runs in CI to minimize wasted cycles found only in CI.
  
  This patch introduces teh maintianer-tools-version file as the source of truth for the version of CI script used in the workspace. The CI tooling as well as the justfile have been updated to pull from it. The justfile has also been extended with recipes which match the CI tasks as close as possible.
  
  Explicit rustup commands were introduced to the justfile with the new "ci" recipe. This isn't expanding scope though since rustup was already implicitly required by tasks like "format" which use the +toolchain syntax.


ACKs for top commit:
  apoelstra:
    ACK 74052cd; successfully ran local tests
  tcharding:
    ACK 74052cd


Tree-SHA512: db2ac558f1bbad25070f6516ca3eb3804fa786fbeb3c7d57f2443e7ddacecbac78bda048c6544a361a800325910639387bc6fb2a1989343bc02200e3d54e8471

Author: apoelstra

.github/workflows/rust.yml

@@ -13,15 +13,19 @@ jobs:
     runs-on: ubuntu-24.04
     outputs:
       nightly_version: ${{ steps.read_toolchain.outputs.nightly_version }}
+      maintainer_tools_version: ${{ steps.read_toolchain.outputs.maintainer_tools_version }}
     steps:
       - name: "Checkout repo"
         uses: actions/checkout@v5
-      - name: "Read nightly version"
+      - name: "Read workspace versions"
         id: read_toolchain
-        run: echo "nightly_version=$(cat nightly-version)" >> $GITHUB_OUTPUT
+        run: |
+          echo "nightly_version=$(cat nightly-version)" >> $GITHUB_OUTPUT
+          echo "maintainer_tools_version=$(cat maintainer-tools-version)" >> $GITHUB_OUTPUT
 
   Stable:                       # 2 jobs, one per manifest.
     name: Test - stable toolchain
+    needs: Prepare
     runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
@@ -34,7 +38,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
@@ -58,7 +62,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@v1
@@ -71,6 +75,7 @@ jobs:
 
   MSRV:                         # 2 jobs, one per manifest.
     name: Test - MSRV toolchain
+    needs: Prepare
     runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
@@ -83,7 +88,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
@@ -109,7 +114,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@v1
@@ -124,6 +129,7 @@ jobs:
 
   Docs:
     name: Docs - stable toolchain
+    needs: Prepare
     runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
@@ -136,7 +142,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
@@ -160,7 +166,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@v1
@@ -186,7 +192,7 @@ jobs:
         uses: actions/checkout@v5
         with:
           repository: rust-bitcoin/rust-bitcoin-maintainer-tools
-          ref: 22eff1e5c114949d4b88a24735da38b37e7984fb
+          ref: ${{ needs.Prepare.outputs.maintainer_tools_version }}
           path: maintainer-tools
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@v1
@@ -335,8 +341,6 @@ jobs:
     steps:
       - name: "Checkout repo"
         uses: actions/checkout@v5
-      - name: "Checkout maintainer tools"
-        uses: actions/checkout@v5
       - name: "Select toolchain"
         uses: dtolnay/rust-toolchain@stable
       - name: "Run policy script"

.gitignore

@@ -19,3 +19,6 @@ mutants.out*
 # Fuzz artifacts
 hfuzz_target
 hfuzz_workspace
+
+# Local tooling
+.maintainer-tools

contrib/ensure-maintainer-tools.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+#
+# Ensure maintainer tools are available locally for CI task execution.
+
+set -euo pipefail
+
+REPO_DIR=$(git rev-parse --show-toplevel)
+MAINTAINER_TOOLS_REF=$(cat "$REPO_DIR/maintainer-tools-version")
+
+cd "$REPO_DIR"
+
+if [ ! -d ".maintainer-tools" ]; then
+    echo "Fetching maintainer tools..."
+    git clone "https://github.com/rust-bitcoin/rust-bitcoin-maintainer-tools.git" ".maintainer-tools"
+    cd ".maintainer-tools"
+    git checkout "$MAINTAINER_TOOLS_REF"
+else
+    cd ".maintainer-tools"
+    CURRENT_REF=$(git rev-parse HEAD)
+    if [ "$CURRENT_REF" != "$MAINTAINER_TOOLS_REF" ]; then
+        echo "Updating maintainer tools to $MAINTAINER_TOOLS_REF"
+        git fetch
+        git checkout "$MAINTAINER_TOOLS_REF"
+    fi
+fi
+
+if ! command -v jq >/dev/null 2>&1; then
+    echo "Error: jq is required for maintainer tools but not found in PATH" >&2
+    echo "Please install jq or ensure it's available in your environment" >&2
+    exit 1
+fi

justfile

@@ -1,10 +1,39 @@
 set positional-arguments
 
+NIGHTLY_VERSION := `cat nightly-version`
+
 alias ulf := update-lock-files
 
 default:
   @just --list
 
+# Run the given CI task using maintainer tools.
+@ci task toolchain="stable" lock="recent":
+  {{justfile_directory()}}/contrib/ensure-maintainer-tools.sh
+  cp -f {{justfile_directory()}}/Cargo-{{lock}}.lock {{justfile_directory()}}/Cargo.lock
+  rustup run {{toolchain}} {{justfile_directory()}}/.maintainer-tools/ci/run_task.sh {{task}}
+
+# Test with stable toolchain.
+test-stable: (ci "stable")
+
+# Test with nightly toolchain.
+test-nightly: (ci "nightly")
+
+# Test with MSRV toolchain.
+test-msrv: (ci "msrv")
+
+# Lint workspace.
+lint: (ci "lint" NIGHTLY_VERSION)
+
+# Generate documentation.
+docs: (ci "docs")
+
+# Generate documentation with nightly.
+docsrs: (ci "docsrs" NIGHTLY_VERSION)
+
+# Run benchmarks.
+bench: (ci "bench")
+
 # Cargo build everything.
 build:
   cargo build --workspace --all-targets --all-features
@@ -13,12 +42,6 @@ build:
 check:
   cargo check --workspace --all-targets --all-features
 
-# Lint everything.
-lint:
-  cargo +$(cat ./nightly-version) clippy --workspace --all-targets --all-features -- --deny warnings
-  # lint warnings get inhibited unless we use `--nocapture`
-  cargo test --quiet --workspace --doc -- --nocapture
-
 # Run cargo fmt
 fmt:
   cargo +$(cat ./nightly-version) fmt --all
@@ -27,10 +50,6 @@ fmt:
 format:
   cargo +$(cat ./nightly-version) fmt --all --check
 
-# Generate documentation.
-docsrs *flags:
-  RUSTDOCFLAGS="--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links" cargo +$(cat ./nightly-version) doc --all-features {{flags}}
-
 # Quick and dirty CI useful for pre-push checks.
 sane: lint
   cargo test --quiet --workspace --all-targets --no-default-features > /dev/null || exit 1
@@ -67,4 +86,3 @@ gen-dep-tree:
         -p bitcoin -p bitcoin-internals -p bitcoin_hashes@0.16.0 -p bitcoin-units \
         -p bitcoin-primitives -p chacha20-poly1305 -p base58ck -p bitcoin-addresses -p bitcoin-io@0.2.0 \
         -p bitcoin-consensus-encoding
-       

maintainer-tools-version

@@ -0,0 +1 @@
+22eff1e5c114949d4b88a24735da38b37e7984fb