Merge pull request #53 from actions-rust-lang/rel-1110

https://github.com/rust-lang/rustfmt/pull/5971
https://github.com/actions-rust-lang/rustfmt/issues/5

.github/workflows/ci.yml

@@ -7,13 +7,21 @@ on:
 
 jobs:
   install:
-    name: Rust ${{matrix.rust || '(toolchain file)'}} ${{matrix.os}}
+    name: Rust ${{matrix.rust || '(default)'}} (toolchain-file=${{matrix.write-toolchain-file}}) (${{matrix.os}})
     runs-on: ${{matrix.os}}
     strategy:
       fail-fast: false
+      max-parallel: 5
       matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        write-toolchain-file:
+          - false
+          - true
         rust:
-          # Test with toolchain file override
+          # use stable toolchain as default
           - null
 
           # Test that the sparse registry check works.
@@ -23,21 +31,17 @@ jobs:
           - "nightly"
           - "beta"
           - "stable"
-        os:
-          - ubuntu-latest
-          - windows-latest
-          - macos-latest
     steps:
       - uses: actions/checkout@v4
 
       # Test toolchain file support
       - name: Write rust-toolchain.toml
-        if: matrix.rust == null
+        if: matrix.write-toolchain-file
         shell: bash
         run: |
           cat <<EOF >>rust-toolchain.toml
           [toolchain]
-          channel = "nightly-2024-01-11"
+          channel = "nightly-2024-01-10"
           components = [ "rustfmt", "rustc-dev" ]
           targets = [ "wasm32-unknown-unknown", "thumbv7m-none-eabi" ]
           profile = "minimal"
@@ -59,6 +63,20 @@ jobs:
       - name: Check ${{'${{steps.toolchain.outputs.rustup-version}}'}}
         run: echo '${{steps.toolchain.outputs.rustup-version}}'
 
+      - name: Check lack of toolchain input or file results in stable
+        if: matrix.write-toolchain-file == false && matrix.rust == null
+        shell: bash
+        run: |-
+          rustcv="$(rustc --version)"
+          [[ "$rustcv" != *"nightly"* && "$rustcv" != *"beta"* ]]
+
+      - name: Check toolchain file is being overridden
+        if: matrix.write-toolchain-file
+        shell: bash
+        run: |-
+          rustcv="$(rustc --version)"
+          [[ ! ( "$rustcv" == *"nightly"* && "$rustcv" == *"2024-01-10"* ) ]]
+
       - shell: bash
         run: rustc --version && cargo --version
 
@@ -70,3 +88,19 @@ jobs:
       - run: cargo add serde_as
 
       - run: cargo clippy
+
+  cache:
+    name: Cache
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: ./
+        with:
+          components: clippy
+          cache: true
+          cache-workspaces: |-
+            ./test-workspace
+
+      - run: cargo clippy --manifest-path=./test-workspace/Cargo.toml

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-json
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.29.2
+    hooks:
+      - id: check-dependabot
+      - id: check-github-actions
+      - id: check-github-workflows

CHANGELOG.md

@@ -7,6 +7,37 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.11.0] - 2025-02-24
+
+* Add new parameter `cache-bin` that is propagated to `Swatinem/rust-cache` as `cache-bin` (#51 by @enkhjile)
+* Add new parameter `cache-shared-key` that is propagated to `Swatinem/rust-cache` as `shared-key` (#52 by @skanehira)
+
+## [1.10.1] - 2024-10-01
+
+* Fix problem matcher for rustfmt output.
+    The format has changed since https://github.com/rust-lang/rustfmt/pull/5971 and now follows the form "filename:line".
+    Thanks to @0xcypher02 for pointing out the problem.
+
+## [1.10.0] - 2024-09-23
+
+* Add new parameter `cache-directories` that is propagated to `Swatinem/rust-cache` (#44 by @pranc1ngpegasus)
+* Add new parameter `cache-key` that is propagated to `Swatinem/rust-cache` as `key` (#41 by @iainlane)
+* Make rustup toolchain installation more robust in light of planned changes https://github.com/rust-lang/rustup/issues/3635 and https://github.com/rust-lang/rustup/pull/3985
+* Allow installing multiple Rust toolchains by specifying multiple versions in the `toolchain` input parameter.
+* Configure the `rustup override` behavior via the new `override` input. (#38)
+
+## [1.9.0] - 2024-06-08
+
+* Add extra argument `cache-on-failure` and forward it to `Swatinem/rust-cache`. (#39 by @samuelhnrq)  
+    Set the default the value to true.
+    This will result in more caching than previously.
+    This helps when large dependencies are compiled only for testing to fail.
+
+## [1.8.0] - 2024-01-13
+
+* Allow specifying subdirectories for cache.
+* Fix toolchain file overriding.
+
 ## [1.7.0] - 2024-01-11
 
 * Allow overriding the toolchain file with explicit `toolchain` input. (#26)

README.md

@@ -48,14 +48,23 @@ If no `toolchain` value or toolchain file is present, it will default to `stable
 First, all items specified in the toolchain file are installed.
 Afterward, the `components` and `target` specified via inputs are installed in addition to the items from the toolchain file.
 
-| Name         | Description                                                                            | Default       |
-| ------------ | -------------------------------------------------------------------------------------- | ------------- |
-| `toolchain`  | Rustup toolchain specifier e.g. `stable`, `nightly`, `1.42.0`.                         | stable        |
-| `target`     | Additional target support to install e.g. `wasm32-unknown-unknown`                     |               |
-| `components` | Comma-separated string of additional components to install e.g. `clippy, rustfmt`      |               |
-| `cache`      | Automatically configure Rust cache (using `Swatinem/rust-cache`)                       | true          |
-| `matcher`    | Enable problem matcher to surface build messages and formatting issues                 | true          |
-| `rustflags`  | Set the value of `RUSTFLAGS` (set to empty string to avoid overwriting existing flags) | "-D warnings" |
+| Name                | Description                                                                                                              | Default       |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------- |
+| `toolchain`         | Comma-separated list of Rustup toolchain specifier e.g. `stable`, `nightly`, `1.42.0`.  The last version is the default. | stable        |
+| `target`            | Additional target support to install e.g. `wasm32-unknown-unknown`                                                       |               |
+| `components`        | Comma-separated string of additional components to install e.g. `clippy, rustfmt`                                        |               |
+| `cache`             | Automatically configure Rust cache (using [`Swatinem/rust-cache`])                                                       | true          |
+| `cache-directories` | Propagates the value to [`Swatinem/rust-cache`]                                                                          |               |
+| `cache-workspaces`  | Propagates the value to [`Swatinem/rust-cache`]                                                                          |               |
+| `cache-on-failure`  | Propagates the value to [`Swatinem/rust-cache`]                                                                          | true          |
+| `cache-key`         | Propagates the value to [`Swatinem/rust-cache`] as `key`                                                                 |               |
+| `cache-shared-key`  | Propagates the value to [`Swatinem/rust-cache`] as `shared-key`                                                          |               |
+| `cache-bin`         | Propagates the value to [`Swatinem/rust-cache`] as `cache-bin`                                                           | true          |
+| `matcher`           | Enable problem matcher to surface build messages and formatting issues                                                   | true          |
+| `rustflags`         | Set the value of `RUSTFLAGS` (set to empty string to avoid overwriting existing flags)                                   | "-D warnings" |
+| `override`          | Setup the last installed toolchain as the default via `rustup override`                                                  | true          |
+
+[`Swatinem/rust-cache`]: https://github.com/Swatinem/rust-cache
 
 ### RUSTFLAGS
 
@@ -81,6 +90,16 @@ You can read more rustflags, and their load order, in the [Cargo reference].
 | `rustup-version` | Version as reported by `rustup --version`   |
 | `cachekey`       | A short hash of the installed rustc version |
 
+## Dependencies
+
+The action works best on the GitHub-hosted runners, but can work on self-hosted ones too, provided the necessary dependencies are available.
+PRs to add support for more environments are welcome.
+
+* bash 5
+* brew (macOS only)
+* rustup or curl (Linux and macOS)
+* using other node actions
+
 ## License
 
 The scripts and documentation in this project are released under the [MIT

action.yml

@@ -13,7 +13,7 @@ branding:
 # The action is heavily inspired by https://github.com/dtolnay/rust-toolchain
 inputs:
   toolchain:
-    description: "Rust toolchain specification -- see https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification"
+    description: "Comma-separated list of Rust toolchain specifications. Last version becomes the default. -- see https://rust-lang.github.io/rustup/concepts/toolchains.html#toolchain-specification"
     required: false
   target:
     description: "Target triple to install for this toolchain"
@@ -25,6 +25,26 @@ inputs:
     description: "Automatically configure Rust cache"
     required: false
     default: "true"
+  cache-workspaces:
+    description: "Paths to multiple Cargo workspaces and their target directories, separated by newlines."
+    required: false
+  cache-directories:
+    description: "Additional non workspace directories to be cached, separated by newlines."
+    required: false
+  cache-on-failure:
+    description: "Also cache on workflow failures"
+    default: "true"
+    required: false
+  cache-key:
+    description: "An additional cache key that is added alongside the automatic `job`-based cache key and can be used to further differentiate jobs."
+    required: false
+  cache-shared-key:
+    description: "A cache key that is used instead of the automatic `job`-based key, and is stable over multiple jobs."
+    required: false
+  cache-bin:
+    description: "Determines whether to cache ${CARGO_HOME}/bin."
+    required: false
+    default: "true"
   matcher:
     description: "Enable the Rust problem matcher"
     required: false
@@ -33,6 +53,10 @@ inputs:
     description: "set RUSTFLAGS environment variable, set to empty string to avoid overwriting build.rustflags"
     required: false
     default: "-D warnings"
+  override:
+    description: "Setup the last installed toolchain as the default via `rustup override`"
+    required: false
+    default: "true"
 
 outputs:
   rustc-version:
@@ -67,7 +91,7 @@ runs:
         : construct rustup command line
         echo "targets=$(for t in ${targets//,/ }; do echo -n ' --target' $t; done)" >> $GITHUB_OUTPUT
         echo "components=$(for c in ${components//,/ }; do echo -n ' --component' $c; done)" >> $GITHUB_OUTPUT
-        echo "downgrade=${{inputs.toolchain == 'nightly' && inputs.components && ' --allow-downgrade' || ''}}" >> $GITHUB_OUTPUT
+        echo "downgrade=${{contains(inputs.toolchain, 'nightly') && inputs.components && ' --allow-downgrade' || ''}}" >> $GITHUB_OUTPUT
 
     # The environment variables always need to be set before the caching action
     - name: Setting Environment Variables
@@ -119,13 +143,16 @@ runs:
         toolchain: ${{inputs.toolchain}}
         targets: ${{inputs.target}}
         components: ${{inputs.components}}
+        override: ${{inputs.override}}
       shell: bash
       run: |
         if [[ -z "$toolchain" && ( -f "rust-toolchain" || -f "rust-toolchain.toml" ) ]]
         then
           # Install the toolchain as specified in the file
-          # Might break at some point: https://github.com/rust-lang/rustup/issues/1397
-          rustup show
+          # rustup show is the old way that implicitly installed a toolchain
+          # rustup toolchain install is the new explicit way
+          # https://github.com/rust-lang/rustup/issues/3635#issuecomment-2343511297
+          rustup show active-toolchain || rustup toolchain install
           if [[ -n $components ]]; then
             rustup component add ${components//,/ }
           fi
@@ -137,8 +164,12 @@ runs:
           then
             toolchain=stable
           fi
-          rustup toolchain install $toolchain${{steps.flags.outputs.targets}}${{steps.flags.outputs.components}} --profile minimal${{steps.flags.outputs.downgrade}} --no-self-update
-          rustup default $toolchain
+          rustup toolchain install ${toolchain//,/ } ${{steps.flags.outputs.targets}}${{steps.flags.outputs.components}} --profile minimal${{steps.flags.outputs.downgrade}} --no-self-update
+          # Take the last element from the list
+          if [[ "$override" == "true" ]]
+          then
+            rustup override set ${toolchain//*,/ }
+          fi
         fi
 
     - id: versions
@@ -171,3 +202,10 @@ runs:
     - name: Setup Rust Caching
       if: inputs.cache == 'true'
       uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: ${{inputs.cache-workspaces}}
+        cache-directories: ${{inputs.cache-directories}}
+        cache-on-failure: ${{inputs.cache-on-failure}}
+        cache-bin: ${{inputs.cache-bin}}
+        key: ${{inputs.cache-key}}
+        shared-key: ${{inputs.cache-shared-key}}

rust.json

@@ -5,7 +5,7 @@
             "severity": "warning",
             "pattern": [
                 {
-                    "regexp": "^(Diff in (.+)) at line (\\d+):$",
+                    "regexp": "^(Diff in (.+))(?: at line |:)(\\d+):$",
                     "message": 1,
                     "file": 2,
                     "line": 3

test-workspace/Cargo.lock

@@ -0,0 +1,16 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "ci"
+version = "0.1.0"
+dependencies = [
+ "serde_as",
+]
+
+[[package]]
+name = "serde_as"
+version = "0.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ee4afe4c5c3b69699c4267ae42b838e911466d7ca0005046adc93ac95bb16dd"

test-workspace/Cargo.toml

@@ -0,0 +1,9 @@
+[package]
+name = "ci"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+serde_as = "0.0.1"

test-workspace/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}