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

CHANGELOG.md

@@ -7,6 +7,11 @@ 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.

README.md

@@ -58,6 +58,8 @@ Afterward, the `components` and `target` specified via inputs are installed in a
 | `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          |
@@ -88,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

@@ -38,6 +38,13 @@ 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"
   matcher:
     description: "Enable the Rust problem matcher"
     required: false
@@ -199,4 +206,6 @@ runs:
         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}}