Merge pull request #40 from actions-rust-lang/prepare-release

Using rustup override set will override a local rust-toolchain.toml file
while rustup default will not.

.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

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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,18 @@ 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`        | 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          |
+| `cache-workspaces` | Propagates the value to [`Swatinem/rust-cache`]                                        |               |
+| `cache-on-failure` | Propagates the value to [`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" |
+
+[`Swatinem/rust-cache`]: https://github.com/Swatinem/rust-cache
 
 ### RUSTFLAGS
 

action.yml

@@ -25,6 +25,13 @@ 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-on-failure:
+    description: "Also cache on workflow failures"
+    default: "true"
+    required: false
   matcher:
     description: "Enable the Rust problem matcher"
     required: false
@@ -138,7 +145,7 @@ runs:
             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 override set $toolchain
         fi
 
     - id: versions
@@ -171,3 +178,6 @@ runs:
     - name: Setup Rust Caching
       if: inputs.cache == 'true'
       uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: ${{inputs.cache-workspaces}}
+        cache-on-failure: ${{inputs.cache-on-failure}}

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!");
+}