Update CHANGELOG.md

CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.13.0] - 2025-06-16
+
+* Add new parameter `cache-provider` that is propagated to `Swatinem/rust-cache` as `cache-provider` (#65 by @mindrunner)
+
+## [1.12.0] - 2025-04-23
+
+* Add support for installing rustup on Windows (#58 by @maennchen)
+    This adds support for using Rust on the GitHub provided Windows ARM runners.
+
+## [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.

README.md

@@ -6,7 +6,7 @@ Caching for Rust tools and build artifacts is enabled.
 Environment variables are set to optimize the cache hits.
 [Problem Matchers] are provided for build messages (cargo, clippy) and formatting (rustfmt).
 
-The action is heavily inspired by *dtolnay*'s <https://github.com/dtolnay/rust-toolchain> and extends it with further features.
+The action is heavily inspired by _dtolnay_'s <https://github.com/dtolnay/rust-toolchain> and extends it with further features.
 
 ## Example workflow
 
@@ -48,19 +48,22 @@ 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`         | 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`                                                                 |               |
-| `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          |
+| 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          |
+| `cache-provider`    | Propagates the value to [`Swatinem/rust-cache`] as `cache-provider`                                                     | 'github'      |
+| `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
 
@@ -69,10 +72,10 @@ Afterward, the `components` and `target` specified via inputs are installed in a
 By default, this action sets the `RUSTFLAGS` environment variable to `-D warnings`.
 However, rustflags sources are mutually exclusive, so setting this environment variable omits any configuration through `target.*.rustflags` or `build.rustflags`.
 
-* If `RUSTFLAGS` is already set, no modifications of the variable are made and the original value remains.
-* If `RUSTFLAGS` is unset and the `rustflags` input is empty (i.e., the empty string), then it will remain unset.
-    Use this, if you want to prevent the value from being set because you make use of `target.*.rustflags` or `build.rustflags`.
-* Otherwise, the environment variable `RUSTFLAGS` is set to the content of `rustflags`.
+- If `RUSTFLAGS` is already set, no modifications of the variable are made and the original value remains.
+- If `RUSTFLAGS` is unset and the `rustflags` input is empty (i.e., the empty string), then it will remain unset.
+  Use this, if you want to prevent the value from being set because you make use of `target.*.rustflags` or `build.rustflags`.
+- Otherwise, the environment variable `RUSTFLAGS` is set to the content of `rustflags`.
 
 To prevent this from happening, set the `rustflags` input to an empty string, which will
 prevent the action from setting `RUSTFLAGS` at all, keeping any existing preferences.
@@ -88,6 +91,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
+- using other node actions
+
 ## License
 
 The scripts and documentation in this project are released under the [MIT

action.yml

@@ -38,6 +38,17 @@ inputs:
   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"
+  cache-provider:
+    description: "Determines which provider to use for caching. Options are github or buildjet, defaults to github."
+    required: false
+    default: "github"
   matcher:
     description: "Enable the Rust problem matcher"
     required: false
@@ -123,13 +134,20 @@ runs:
       run: echo "::add-matcher::${{ github.action_path }}/rust.json"
 
     - name: Install rustup, if needed
-      if: runner.os != 'Windows'
       shell: bash
       run: |
         if ! command -v rustup &> /dev/null ; then
           curl --proto '=https' --tlsv1.2 --retry 10 --retry-connrefused -fsSL "https://sh.rustup.rs" | sh -s -- --default-toolchain none -y
-          echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
+          
+          # Resolve the correct CARGO_HOME path depending on OS
+          if [[ "$RUNNER_OS" == "Windows" ]]; then
+            echo "${CARGO_HOME:-$USERPROFILE/.cargo}/bin" | sed 's|/|\\|g' >> $GITHUB_PATH
+          else
+            echo "${CARGO_HOME:-$HOME/.cargo}/bin" >> $GITHUB_PATH
+          fi
         fi
+      env:
+        RUNNER_OS: "${{ runner.os }}"
 
     - name: rustup toolchain install ${{inputs.toolchain || 'stable'}}
       env:
@@ -199,4 +217,7 @@ runs:
         workspaces: ${{inputs.cache-workspaces}}
         cache-directories: ${{inputs.cache-directories}}
         cache-on-failure: ${{inputs.cache-on-failure}}
+        cache-bin: ${{inputs.cache-bin}}
+        cache-provider: ${{inputs.cache-provider}}
         key: ${{inputs.cache-key}}
+        shared-key: ${{inputs.cache-shared-key}}