chore: update from changes in other projects

clechasseur · clechasseur · commit 07bd058c7129 · 2025-04-05T17:05:03.000-04:00
diff --git a/.github/workflows/audit-check.yml b/.github/workflows/audit-check.yml
@@ -9,7 +9,7 @@ on:
 
 jobs:
   audit-check:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     permissions:
       checks: write
       issues: write
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -6,16 +6,13 @@ on:
   workflow_dispatch:
 
 env:
+  CARGO_TERM_COLOR: always
   CI: 1
 
 jobs:
   clippy:
-    name: Clippy validation${{ matrix.all-features && ' with all features' || '' }}
-    strategy:
-      fail-fast: false
-      matrix:
-        all-features: [ false ] # TODO if your crate has optional features, add 'true' to this list
-    runs-on: ubuntu-latest
+    name: Clippy validation
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -30,18 +27,19 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
         with:
-          prefix-key: v1-rust
-          key: all-features-${{ matrix.all-features }}
+          prefix-key: v2-rust
           cache-on-failure: true
 
       - name: Run clippy
         uses: clechasseur/rs-clippy-check@23f6dcf86d7e4e0d98b000bba0bb81ac587c44aa # v4.0.2
         with:
-          args: --workspace --all-targets ${{ matrix.all-features && '--all-features' || '' }} -- -D warnings
+          args: --workspace --all-targets --feature-powerset -- -D warnings
+          tool: cargo-hack
+          cache-key: v1-clippy
 
   fmt:
     name: Rustfmt check
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -59,14 +57,13 @@ jobs:
           args: --all
 
   msrv-check:
-    name: MSRV check for Rust ${{ matrix.toolchain }} on ${{ matrix.os }}${{ matrix.all-features && ' with all features' || '' }}
+    name: MSRV check for Rust ${{ matrix.toolchain }} on ${{ matrix.os }}
     strategy:
       fail-fast: false
       matrix:
+        os: [ ubuntu-24.04, macos-14, windows-2022 ]
         toolchain: [ 1.60.0 ] # TODO: change for your minimum supported Rust version
-        os: [ ubuntu, macos, windows ]
-        all-features: [ false ] # TODO if your crate has optional features, add 'true' to this list
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -80,29 +77,28 @@ jobs:
       - name: Rust Cache
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
         with:
-          prefix-key: v7-rust
-          key: all-features-${{ matrix.all-features }}-msrv-pins-files-${{ hashFiles('**/msrv-pins.toml') }}
+          prefix-key: v10-rust
+          key: msrv-pins-files-${{ hashFiles('**/msrv-pins.toml') }}
           cache-on-failure: true
 
       - name: Install required tools
         uses: taiki-e/install-action@f1390fd0d8205ae79e5e57b1d1e300dceeb4163e # v2.49.44
         with:
-          tool: just,cargo-hack,cargo-minimal-versions,cargo-msrv,cargo-msrv-prep
+          tool: just,cargo-hack,cargo-minimal-versions,cargo-msrv-prep
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run checks using cargo-minimal-versions
-        run: just all_features=${{ matrix.all-features }} check-minimal
+        run: just toolchain=${{ matrix.toolchain }} check-minimal
 
   build:
-    name: Build for Rust ${{ matrix.toolchain }}${{ matrix.experimental && ' (experimental)' || '' }} on ${{ matrix.os }}${{ matrix.ignore-lock && ' without Cargo.lock' || '' }}${{ matrix.all-features && ' with all features' || '' }}
+    name: Build for Rust ${{ matrix.toolchain }}${{ matrix.experimental && ' (experimental)' || '' }} on ${{ matrix.os }}${{ matrix.ignore-lock && ' without Cargo.lock' || '' }}
     strategy:
       fail-fast: false
       matrix:
         toolchain: [ 1.68.2, stable, beta, nightly ] # TODO: change 1.68.2 for your minimum supported Rust version
-        os: [ ubuntu, macos, windows ]
+        os: [ ubuntu-24.04, macos-14, windows-2022 ]
         ignore-lock: [ false, true ]
-        all-features: [ false ] # TODO if your crate has optional features, add 'true' to this list
         include:
           - experimental: false
           - toolchain: beta
@@ -112,7 +108,7 @@ jobs:
         exclude:
           - toolchain: 1.68.2 # TODO: change this version to match the minimum supported Rust version specified above
             ignore-lock: true
-    runs-on: ${{ matrix.os }}-latest
+    runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}
     steps:
       - name: Checkout code
@@ -132,71 +128,60 @@ jobs:
         if: ${{ !matrix.experimental }}
         uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
         with:
-          prefix-key: v2-rust
-          key: ignore-lock-${{ matrix.ignore-lock }}-all-features-${{ matrix.all-features }}
+          prefix-key: v3-rust
+          key: ignore-lock-${{ matrix.ignore-lock }}
           cache-on-failure: true
 
-      - name: Install just
+      - name: Install required tools
         uses: taiki-e/install-action@f1390fd0d8205ae79e5e57b1d1e300dceeb4163e # v2.49.44
         with:
-          tool: just
+          tool: just,cargo-hack
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Run checks
-        run: just all_features=${{ matrix.all-features }} check
+      - name: Run checks on feature powerset
+        run: just check-powerset
 
       - name: Run tests
-        run: just all_features=${{ matrix.all-features }} test
-
-  tarpaulin:
-    # Note: there seems to be an issue in `cargo-tarpaulin` when using Rust 1.75.0 or later - it reports some missing line coverage.
-    # I've entered an issue: https://github.com/xd009642/tarpaulin/issues/1438
-    # In the meantime, let's pin the Rust version used for code coverage to 1.74.1 until we know what's happening.
-    name: Code coverage
-    runs-on: ubuntu-latest
+        run: just test
+
+  llvm-cov:
+    name: Code coverage with llvm-cov
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout code
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
-      - name: Install Rust
+      - name: Install Rust nightly
         uses: actions-rust-lang/setup-rust-toolchain@9399c7bb15d4c7d47b27263d024f0a4978346ba4 # v1.11.0
         with:
-          toolchain: 1.74.1
+          toolchain: nightly
           cache: false
 
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
-        with:
-          prefix-key: v2-rust
-          cache-targets: false
-          cache-on-failure: true
-
-      - name: Install cargo-tarpaulin
+      - name: Install required tools
         uses: taiki-e/install-action@f1390fd0d8205ae79e5e57b1d1e300dceeb4163e # v2.49.44
         with:
-          tool: cargo-tarpaulin
+          tool: just,cargo-llvm-cov
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Run cargo-tarpaulin
-        uses: clechasseur/rs-cargo@319e211e9459c5e531afb6d157296765b441572e # v3.0.3
-        with:
-          command: tarpaulin
+      - name: Run cargo-llvm-cov
+        run: just llvm-cov
 
       - name: Upload code coverage results to codecov.io
         uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+          files: codecov.json
           fail_ci_if_error: true
 
       - name: Archive code coverage results
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
-          name: code-coverage-report
+          name: llvm-cov-code-coverage-report
           path: |
-            cobertura.xml
-            tarpaulin-report.html
+            codecov.json
+            target/llvm-cov/html/
 
   doc:
     name: Rustdoc check for Rust ${{ matrix.toolchain }}${{ matrix.experimental && ' (experimental)' || '' }}
@@ -208,7 +193,7 @@ jobs:
           - experimental: false
           - toolchain: nightly
             experimental: true
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     continue-on-error: ${{ matrix.experimental }}
     steps:
       - name: Checkout code
@@ -237,29 +222,3 @@ jobs:
 
       - name: Generate doc using rustdoc
         run: just doc
-
-  publish-dry-run:
-    name: Publish dry-run
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-
-      - name: Install Rust
-        uses: actions-rust-lang/setup-rust-toolchain@9399c7bb15d4c7d47b27263d024f0a4978346ba4 # v1.11.0
-        with:
-          toolchain: stable
-          cache: false
-
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
-        with:
-          prefix-key: v2-rust
-          cache-targets: false
-          cache-on-failure: true
-
-      - name: Perform publish dry-run
-        uses: clechasseur/rs-cargo@319e211e9459c5e531afb6d157296765b441572e # v3.0.3
-        with:
-          command: publish
-          args: --dry-run
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,33 @@
+name: Publish to crates.io
+
+on:
+  # TODO re-enable once project is set up properly if you have crates to publish, otherwise remove the workflow
+  #push:
+  #  tags:
+  #    - v[0-9]+.[0-9]+.[0-9]+
+  workflow_dispatch:
+
+jobs:
+  publish:
+    env:
+      CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Install Rust
+        uses: actions-rust-lang/setup-rust-toolchain@9399c7bb15d4c7d47b27263d024f0a4978346ba4 # v1.11.0
+        with:
+          toolchain: stable
+          cache: false
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
+        with:
+          cache-on-failure: true
+
+      - name: Publish package
+        uses: clechasseur/rs-cargo@319e211e9459c5e531afb6d157296765b441572e # v3.0.3
+        with:
+          command: publish
diff --git a/.gitignore b/.gitignore
@@ -8,9 +8,6 @@ target*/
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
-# Files that exist while we run `cargo minimal-versions`/`cargo msrv`
-*.msrv-prep*.bak
-
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
 
@@ -21,7 +18,12 @@ target*/
 # docker-compose.override.yml is meant to be local-only
 docker-compose.override.yml
 
-# Profiling files generated by cargo-tarpaulin
+# Profiling files generated by cargo-tarpaulin and cargo-llvm-cov
 *.profraw
 cobertura.xml
 tarpaulin-report.*
+cov.json
+codecov.json
+
+# Local environment overrides
+.env
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -13,13 +13,13 @@ rustup update
 
 ### Rust nightly
 
-In order to run `rustfmt`, you will need a Nightly Rust toolset. If you do not have one installed, you can install one via `rustup` by running
+Certain tools require a Nightly Rust toolset. If you do not have one installed, you can install one via `rustup` by running
 
 ```bash
 rustup toolchain install nightly
 ```
 
-If you already have one installed but it was too old, it was probably updated earlier when you ran `rustup update` 😉
+If you already have one installed, but it was too old, it was probably updated earlier when you ran `rustup update` 😉
 
 ### Just
 
@@ -28,7 +28,7 @@ If you already have one installed but it was too old, it was probably updated ea
 This project includes a [justfile](justfile) that makes it easier to run the various tools used for development. To install `just` via `cargo`, simply run
 
 ```bash
-cargo install just
+cargo install just --locked
 ```
 
 If you have [cargo-binstall](https://github.com/cargo-bins/cargo-binstall), it'll probably be faster to use it instead:
@@ -39,17 +39,17 @@ cargo binstall just
 
 You can also install it via various [methods](https://github.com/casey/just#packages).
 
-### Tarpaulin
+### Llvm-cov
 
-If you want to run tests with coverage locally, you'll need to install [`cargo-tarpaulin`](https://github.com/xd009642/tarpaulin), a code coverage tool for Rust. You can install it via `cargo`:
+If you want to run tests with coverage locally, you'll need to install [`cargo-llvm-cov`](https://github.com/taiki-e/cargo-llvm-cov), a code coverage tool for Rust. You can install it via `cargo`:
 
 ```bash
-cargo install cargo-tarpaulin
+cargo install cargo-llvm-cov --locked
 ```
 You can also install it via [cargo-binstall](https://github.com/cargo-bins/cargo-binstall):
 
 ```bash
-cargo binstall cargo-tarpaulin
+cargo binstall cargo-llvm-cov
 ```
 
 ## Development
@@ -76,10 +76,10 @@ Required checks will not pass if either of those report issues.
 
 ### Code coverage
 
-This project's [code coverage settings](codecov.yml) are pretty stringent and require **100% coverage**. To validate this locally, you can run
+This project's [code coverage settings](codecov.yml) are pretty stringent. To validate this locally, you can run
 
 ```bash
-just tarpaulin
+just llvm-cov
 ```
 
 Make sure coverage is at the required level before submitting a PR.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Charles Lechasseur
+Copyright (c) 2025 Charles Lechasseur
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/codecov.yml b/codecov.yml
@@ -1,6 +1,9 @@
 coverage:
+  range: "80...95"
   status:
     project:
       default:
-        target: 100%
-        threshold: 1%
+        threshold: 100
+    patch:
+      default:
+        threshold: 100
diff --git a/justfile b/justfile
