Merge pull request #2026 from EliahKagan/run-ci/check-msrv-next

Make MSRV checks and updates easier and more thorough

Author: EliahKagan

.github/workflows/ci.yml

@@ -487,7 +487,7 @@ jobs:
           sort -m blocking-jobs.txt expected-nonblocking-jobs.txt |
             diff --color=always -U1000 - all-jobs.txt
 
-  # Dummy job to have a stable name for the "all tests pass" requirement
+  # Dummy job to have a stable name for the "all tests pass" requirement.
   tests-pass:
     name: Tests pass
 
@@ -504,7 +504,7 @@ jobs:
       - check-packetline
       - check-blocking
 
-    if: always() # always run even if dependencies fail
+    if: always()  # Always run even if dependencies fail.
 
     runs-on: ubuntu-latest
 

.github/workflows/msrv.yml

@@ -28,22 +28,55 @@ jobs:
 
     runs-on: ${{ matrix.os }}
 
-    env:
-      # This is dictated by `firefox` to support the `helix` editor, but now probably effectively
-      # be controlled by `jiff`, which also aligns with `regex`.
-      # IMPORTANT: When adjusting, change all occurrences in `etc/msrv-badge.svg` as well.
-      RUST_VERSION: 1.75.0
+    defaults:
+      run:
+        shell: bash  # Use `bash` even in the Windows job.
 
     steps:
       - uses: actions/checkout@v4
       - uses: extractions/setup-just@v3
-      - name: Set up ${{ env.RUST_VERSION }} (MSRV) and nightly toolchains
-        run: rustup toolchain install ${{ env.RUST_VERSION }} nightly --profile minimal --no-self-update
-      - name: Set ${{ env.RUST_VERSION }} (MSRV) as default
-        run: rustup default ${{ env.RUST_VERSION }}
+      - name: Read the MSRV
+        run: |
+          msrv="$(just msrv)"
+          tee -a "$GITHUB_ENV" <<<"MSRV=$msrv"
+      - name: Set up MSRV and nightly toolchains
+        run: |
+          rustup toolchain install "$MSRV" nightly --profile minimal --no-self-update
       - name: Downgrade locked dependencies to lowest allowed versions
         run: |
           # TODO(msrv): Use `cargo update --minimal-versions` when `--minimal-versions` is available.
           cargo +nightly update -Zminimal-versions
       - name: Run some `cargo build` commands on `gix`
-        run: just ci-check-msrv
+        run: just check-rust-version "$MSRV"
+
+  check-msrv-badge:
+    name: Check MSRV badge
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: extractions/setup-just@v3
+      - name: Ensure we start out clean
+        run: git diff --exit-code
+      - name: Regenerate the MSRV badge
+        run: just msrv-badge
+      - name: Check for changes
+        run: git diff --exit-code
+
+  # Dummy job to have a stable name for the requirement that all MSRV checks pass.
+  msrv-pass:
+    name: MSRV checks pass
+
+    needs: [ check-msrv, check-msrv-badge ]
+
+    if: always()  # Always run even if dependencies fail.
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Fail if ANY dependency has failed or cancelled
+        if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+        run: exit 1
+      - name: OK
+        run: exit 0

Makefile

@@ -124,11 +124,6 @@ stress-commitgraph: release-lean $(commit_graphs)
 bench-gix-config:
 	cd gix-config && cargo bench
 
-check-msrv-on-ci: ## Check the minimal support rust version for currently installed Rust version
-	rustc --version
-	cargo build --locked --package gix
-	cargo build --locked --package gix --no-default-features --features async-network-client,max-performance
-
 ##@ Maintenance
 
 baseline_asset_dir = gix/src/assets/baseline-init

etc/msrv-badge.template.svg

@@ -9,6 +9,8 @@ version = "0.72.1"
 authors = ["Sebastian Thiel <sebastian.thiel@icloud.com>"]
 edition = "2021"
 include = ["src/**/*", "LICENSE-*"]
+# This MSRV is dictated by `firefox` to support the `helix` editor, but is now probably
+# effectively controlled by `jiff`, which also aligns with `regex`.
 rust-version = "1.75"
 
 [lib]

gix/Cargo.toml

@@ -184,34 +184,36 @@ unit-tests:
 unit-tests-flaky:
     cargo test -p gix --features async-network-client-async-std
 
-# Depend on this to pre-generate metadata, and/or use it inside a recipe as `"$({{ j }} dbg)"`
+# Extract cargo metadata, excluding dependencies, and query it
 [private]
-dbg:
-    set -eu; \
-        target_dir="$(cargo metadata --format-version 1 | jq -r .target_directory)"; \
-        test -n "$target_dir"; \
-        echo "$target_dir/debug"
+query-meta jq-query:
+    meta="$(cargo metadata --format-version 1 --no-deps)" && \
+        printf '%s\n' "$meta" | jq --exit-status --raw-output -- {{ quote(jq-query) }}
+
+# Get the path to the directory where debug binaries are created during builds
+[private]
+dbg: (query-meta '.target_directory + "/debug"')
 
 # Run journey tests (`max`)
-journey-tests: dbg
+journey-tests:
     cargo build --features http-client-curl-rustls
     cargo build -p gix-testtools --bin jtt
     dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" max
 
 # Run journey tests (`max-pure`)
-journey-tests-pure: dbg
+journey-tests-pure:
     cargo build --no-default-features --features max-pure
     cargo build -p gix-testtools --bin jtt
     dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" max-pure
 
 # Run journey tests (`small`)
-journey-tests-small: dbg
+journey-tests-small:
     cargo build --no-default-features --features small
     cargo build -p gix-testtools
     dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" small
 
 # Run journey tests (`lean-async`)
-journey-tests-async: dbg
+journey-tests-async:
     cargo build --no-default-features --features lean-async
     cargo build -p gix-testtools
     dbg="$({{ j }} dbg)" && tests/journey.sh "$dbg/ein" "$dbg/gix" "$dbg/jtt" async
@@ -238,16 +240,25 @@ cross-test-android: (cross-test 'armv7-linux-androideabi' '--no-default-features
 check-size:
     etc/check-package-size.sh
 
-# This assumes the current default toolchain is the Minimal Supported Rust Version and checks
-# against it. This is run on CI in `msrv.yml`, after the MSRV toolchain is installed and set as
-# default, and after dependencies in `Cargo.lock` are downgraded to the latest MSRV-compatible
-# versions. Only if those or similar steps are done first does this work to validate the MSRV.
-#
-# Check the MSRV, *if* the toolchain is set and `Cargo.lock` is downgraded (used on CI)
-ci-check-msrv:
-    rustc --version
-    cargo build --locked -p gix
-    cargo build --locked -p gix --no-default-features --features async-network-client,max-performance
+# Report the Minimum Supported Rust Version (the `rust-version` of `gix`) in X.Y.Z form
+msrv: (query-meta '''
+    .packages[]
+    | select(.name == "gix")
+    | .rust_version
+    | sub("(?<xy>^[0-9]+[.][0-9]+$)"; "\(.xy).0")
+''')
+
+# Regenerate the MSRV badge SVG
+msrv-badge:
+    msrv="$({{ j }} msrv)" && \
+        sed "s/{MSRV}/$msrv/g" etc/msrv-badge.template.svg >etc/msrv-badge.svg
+
+# Check if `gix` and its dependencies, as currently locked, build with `rust-version`
+check-rust-version rust-version:
+    rustc +{{ rust-version }} --version
+    cargo +{{ rust-version }} build --locked -p gix
+    cargo +{{ rust-version }} build --locked -p gix \
+        --no-default-features --features async-network-client,max-performance
 
 # Enter a nix-shell able to build on macOS
 nix-shell-macos: