Document new keys and add changelog
This commit is contained in:
parent
a90048dfdd
commit
eb4a655afd
|
@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||
|
||||
## [Unreleased]
|
||||
|
||||
* 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)
|
||||
|
||||
## [1.9.0] - 2024-06-08
|
||||
|
||||
* Add extra argument `cache-on-failure` and forward it to `Swatinem/rust-cache`. (#39 by @samuelhnrq)
|
||||
|
|
23
README.md
23
README.md
|
@ -48,17 +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 |
|
||||
| `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" |
|
||||
| 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-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" |
|
||||
|
||||
[`Swatinem/rust-cache`]: https://github.com/Swatinem/rust-cache
|
||||
|
||||
|
|
Loading…
Reference in New Issue