Merge pull request #147 from epage/template

chore: Update from _rust/main template

Author: epage

.cargo/config.toml

@@ -0,0 +1,2 @@
+[resolver]
+incompatible-rust-versions = "fallback"

.github/renovate.json5

@@ -6,16 +6,19 @@
   commitMessageLowerCase: 'never',
   configMigration: true,
   dependencyDashboard: true,
+  "pre-commit": {
+    enabled: true
+  },
   customManagers: [
     {
       customType: 'regex',
-      fileMatch: [
-        '^rust-toolchain\\.toml$',
-        'Cargo.toml$',
-        'clippy.toml$',
-        '\\.clippy.toml$',
-        '^\\.github/workflows/ci.yml$',
-        '^\\.github/workflows/rust-next.yml$',
+      managerFilePatterns: [
+        '/^rust-toolchain\\.toml$/',
+        '/Cargo.toml$/',
+        '/clippy.toml$/',
+        '/\\.clippy.toml$/',
+        '/^\\.github/workflows/ci.yml$/',
+        '/^\\.github/workflows/rust-next.yml$/',
       ],
       matchStrings: [
         'STABLE.*?(?<currentValue>\\d+\\.\\d+(\\.\\d+)?)',
@@ -25,6 +28,18 @@
       packageNameTemplate: 'rust-lang/rust',
       datasourceTemplate: 'github-releases',
     },
+    {
+      customType: 'regex',
+      managerFilePatterns: [
+        '/^\\.github/workflows/pre-commit.yml$/',
+      ],
+      matchStrings: [
+        'prek-version.*?(?<currentValue>\\d+\\.\\d+(\\.\\d+)?)',
+      ],
+      depNameTemplate: 'prek',
+      packageNameTemplate: 'j178/prek',
+      datasourceTemplate: 'github-releases',
+    },
   ],
   packageRules: [
     {
@@ -41,6 +56,20 @@
       ],
       automerge: true,
     },
+    {
+      commitMessageTopic: 'Prek',
+      matchManagers: [
+        'custom.regex',
+      ],
+      matchDepNames: [
+        'prek',
+      ],
+      extractVersion: '^(?<version>\\d+\\.\\d+\\.\\d+)',
+      schedule: [
+        '* * * * *',
+      ],
+      automerge: true,
+    },
     // Goals:
     // - Keep version reqs low, ignoring compatible normal/build dependencies
     // - Take advantage of latest dev-dependencies

.github/workflows/ci.yml

@@ -38,6 +38,9 @@ jobs:
         rust: ["stable"]
     continue-on-error: ${{ matrix.rust != 'stable' }}
     runs-on: ${{ matrix.os }}
+    env:
+      # Reduce amount of data cached
+      CARGO_PROFILE_DEV_DEBUG: line-tables-only
     steps:
     - name: Checkout repository
       uses: actions/checkout@v6
@@ -50,10 +53,13 @@ jobs:
     - name: Build
       run: cargo test --workspace --no-run
     - name: Test
-      run: cargo hack test --feature-powerset --workspace
+      run: cargo hack test --each-feature --workspace
   msrv:
     name: "Check MSRV"
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: ["ubuntu-latest"]
+    runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout repository
       uses: actions/checkout@v6
@@ -64,10 +70,13 @@ jobs:
     - uses: Swatinem/rust-cache@v2
     - uses: taiki-e/install-action@cargo-hack
     - name: Default features
-      run: cargo hack check --feature-powerset --locked --rust-version --ignore-private --workspace --all-targets
+      run: cargo hack check --each-feature --locked --rust-version --ignore-private --workspace --all-targets --keep-going
   minimal-versions:
     name: Minimal versions
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: ["ubuntu-latest"]
+    runs-on: ${{ matrix.os }}
     steps:
     - name: Checkout repository
       uses: actions/checkout@v6
@@ -82,7 +91,7 @@ jobs:
     - name: Downgrade dependencies to minimal versions
       run: cargo +nightly generate-lockfile -Z minimal-versions
     - name: Compile with minimal versions
-      run: cargo +stable check --workspace --all-features --locked
+      run: cargo +stable check --workspace --all-features --locked --keep-going
   lockfile:
     runs-on: ubuntu-latest
     steps:
@@ -104,12 +113,12 @@ jobs:
     - name: Install Rust
       uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: "1.83"  # STABLE
+        toolchain: "1.93"  # STABLE
     - uses: Swatinem/rust-cache@v2
     - name: Check documentation
       env:
         RUSTDOCFLAGS: -D warnings
-      run: cargo doc --workspace --all-features --no-deps --document-private-items
+      run: cargo doc --workspace --all-features --no-deps --document-private-items --keep-going
   rustfmt:
     name: rustfmt
     runs-on: ubuntu-latest
@@ -119,11 +128,11 @@ jobs:
     - name: Install Rust
       uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: "1.83"  # STABLE
+        toolchain: "1.93"  # STABLE
         components: rustfmt
     - uses: Swatinem/rust-cache@v2
     - name: Check formatting
-      run: cargo fmt --all -- --check
+      run: cargo fmt --check
   clippy:
     name: clippy
     runs-on: ubuntu-latest
@@ -135,7 +144,7 @@ jobs:
     - name: Install Rust
       uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: "1.83"  # STABLE
+        toolchain: "1.93"  # STABLE
         components: clippy
     - uses: Swatinem/rust-cache@v2
     - name: Install SARIF tools
@@ -144,7 +153,7 @@ jobs:
       run: cargo install sarif-fmt --locked
     - name: Check
       run: >
-        cargo clippy --workspace --all-features --all-targets --message-format=json -- -D warnings --allow deprecated
+        cargo clippy --workspace --all-features --all-targets --message-format=json
         | clippy-sarif
         | tee clippy-results.sarif
         | sarif-fmt
@@ -155,7 +164,7 @@ jobs:
         sarif_file: clippy-results.sarif
         wait-for-processing: true
     - name: Report status
-      run: cargo clippy --workspace --all-features --all-targets -- -D warnings --allow deprecated
+      run: cargo clippy --workspace --all-features --all-targets --keep-going -- -D warnings --allow deprecated
   coverage:
     name: Coverage
     runs-on: ubuntu-latest

.github/workflows/pre-commit.yml

@@ -23,7 +23,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v6
-    - uses: actions/setup-python@v6
+    - uses: j178/prek-action@v1
       with:
-        python-version: '3.x'
-    - uses: pre-commit/action@v3.0.1
+        prek-version: '0.2.27'

.github/workflows/rust-next.yml

@@ -28,6 +28,9 @@ jobs:
           rust: "nightly"
     continue-on-error: ${{ matrix.rust != 'stable' }}
     runs-on: ${{ matrix.os }}
+    env:
+      # Reduce amount of data cached
+      CARGO_PROFILE_DEV_DEBUG: line-tables-only
     steps:
     - name: Checkout repository
       uses: actions/checkout@v6
@@ -40,10 +43,15 @@ jobs:
     - name: Build
       run: cargo test --workspace --no-run
     - name: Test
-      run: cargo hack test --feature-powerset --workspace
+      run: cargo hack test --each-feature --workspace
   latest:
     name: "Check latest dependencies"
-    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: ["ubuntu-latest"]
+    runs-on: ${{ matrix.os }}
+    env:
+      CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS: allow
     steps:
     - name: Checkout repository
       uses: actions/checkout@v6
@@ -58,4 +66,4 @@ jobs:
     - name: Build
       run: cargo test --workspace --no-run
     - name: Test
-      run: cargo hack test --feature-powerset --workspace
+      run: cargo hack test --each-feature --workspace

.github/workflows/template.yml

@@ -0,0 +1,58 @@
+name: Template Update
+
+permissions:
+  contents: read
+
+on:
+  schedule:
+  - cron: '1 1 1 * *'
+  workflow_dispatch:
+
+env:
+  RUST_BACKTRACE: 1
+  CARGO_TERM_COLOR: always
+  CLICOLOR: 1
+  TEMPLATE_URL: "https://github.com/epage/_rust.git"
+  TEMPLATE_BRANCH: "main"
+
+concurrency:
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  update:
+    permissions:
+      security-events: write # to create PR
+      pull-requests: write
+      contents: write # to push the branch
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+    - name: Configure git
+      run: |
+        git config --global user.name '${{ github.actor }}'
+        git config --global user.email '<>'
+    - name: Fetch template
+      run: "git remote add template ${{ env.TEMPLATE_URL }} && git fetch template ${{ env.TEMPLATE_BRANCH }}"
+    - name: Merge template
+      run: "git checkout -b template-update && git merge template/${{ env.TEMPLATE_BRANCH }} -m 'chore: Update from template'"
+    - name: Clear any existing branch
+      run: "git push origin --delete template-update"
+      continue-on-error: true
+      env:
+        GH_TOKEN: ${{ github.token }}
+    - name: Push branch
+      run: "git push --set-upstream origin template-update"
+      env:
+        GH_TOKEN: ${{ github.token }}
+    - name: Create PR
+      run: "gh pr create --head template-update --title 'chore: Update from template' --body ''"
+      env:
+        GH_TOKEN: ${{ github.token }}
+    - name: Merge PR
+      run: "gh pr merge --auto --delete-branch"
+      env:
+        GH_TOKEN: ${{ github.token }}

.pre-commit-config.yaml

@@ -1,26 +1,19 @@
+default_install_hook_types: ["pre-commit", "commit-msg"]
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v6.0.0
     hooks:
     - id: check-yaml
-      stages: [commit]
     - id: check-json
-      stages: [commit]
     - id: check-toml
-      stages: [commit]
     - id: check-merge-conflict
-      stages: [commit]
     - id: check-case-conflict
-      stages: [commit]
     - id: detect-private-key
-      stages: [commit]
   - repo: https://github.com/crate-ci/typos
-    rev: v1.16.20
+    rev: v1.42.1
     hooks:
     - id: typos
-      stages: [commit]
   - repo: https://github.com/crate-ci/committed
-    rev: v1.0.20
+    rev: v1.1.10
     hooks:
     - id: committed
-      stages: [commit-msg]

CHANGELOG.md

@@ -1,7 +1,9 @@
 # Change Log
 
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](https://semver.org/).
 
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate

CONTRIBUTING.md

@@ -7,18 +7,18 @@ appreciate any level you're willing to do.
 
 Need some new functionality to help?  You can let us know by opening an
 [issue][new issue]. It's helpful to look through [all issues][all issues] in
-case its already being talked about.
+case it's already being talked about.
 
 ## Bug Reports
 
 Please let us know about what problems you run into, whether in behavior or
 ergonomics of API.  You can do this by opening an [issue][new issue]. It's
-helpful to look through [all issues][all issues] in case its already being
+helpful to look through [all issues][all issues] in case it's already being
 talked about.
 
 ## Pull Requests
 
-Looking for an idea? Check our [issues][issues]. If it's look more open ended,
+Looking for an idea? Check our [issues][issues]. If the issue looks open ended,
 it is probably best to post on the issue how you are thinking of resolving the
 issue so you can get feedback early in the process. We want you to be
 successful and it can be discouraging to find out a lot of re-work is needed.
@@ -41,15 +41,18 @@ As a heads up, we'll be running your PR through the following gauntlet:
 Not everything can be checked automatically though.
 
 We request that the commit history gets cleaned up.
+
 We ask that commits are atomic, meaning they are complete and have a single responsibility.
-PRs should tell a cohesive story, with test and refactor commits that keep the
+A complete commit should build, pass tests, update documentation and tests, and not have dead code.
+
+PRs should tell a cohesive story, with refactor and test commits that keep the
 fix or feature commits simple and clear.
 
 Specifically, we would encourage
 - File renames be isolated into their own commit
-- Add tests in a commit before their feature or fix, showing the current behavior.
+- Add tests in a commit before their feature or fix, showing the current behavior (i.e. they should pass).
   The diff for the feature/fix commit will then show how the behavior changed,
-  making it clearer to reviewrs and the community and showing people that the
+  making the commit's intent clearer to reviewers and the community, and showing people that the
   test is verifying the expected state.
   - e.g. [clap#5520](https://github.com/clap-rs/clap/pull/5520)