actions/setup-rust
1
0
Fork 0
mirror of https://github.com/moonrepo/setup-rust.git synced 2025-04-20 09:38:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add inputs to readme.

Browse source
This commit is contained in:
Miles Johnson 2023-05-08 10:21:58 -07:00
parent b07b2e2e9e
commit 7229efd154
2 changed files with 31 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -15,6 +15,21 @@ jobs:
- run: cargo test
```
## Inputs
The following inputs are available for the action, and can be passed via `with`. All inputs are
optional.
- `bins` - Comma-separated list of global binaries to install into Cargo.
- `cache` - Toggle caching of directories. Defaults to `true`.
- `cache-target` - Name of the target profile to cache. Defaults to `debug`.
- `channel` - Toolchain specification/channel to explicitly install.
- `components` - Comma-separated list of additional components to install.
- `inherit-toolchain` - Inherit all toolchain settings from the `rust-toolchain.toml` file. Defaults
to `false`.
- `targets` - Comma-separated list of additional targets to install.
- `profile` - Profile to install. Defaults to `minimal`.
## Configuring the Rust toolchain
This action will automatically install the appropriate toolchain with `rustup` by inspecting the
@ -41,10 +56,11 @@ highest precedence.
channel: '1.65.0'
```
### Profile and components
### Profile, components, and targets
Furthermore, this action supports rustup profiles and components, which can be configured with the
`profile` and `components` inputs respectively. When not defined, profile defaults to `minimal`.
Furthermore, this action supports rustup profiles, components, and targets, which can be configured
with the `profile`, `components`, and `targets` inputs respectively. When not defined, profile
defaults to `minimal`.
```yaml
- uses: moonrepo/setup-rust@v0
@ -61,6 +77,14 @@ When using components, the input requires a comma separated list of component na
- run: cargo clippy --workspace
```
When using targets, the input requires a comma separated list of target triples.
```yaml
- uses: moonrepo/setup-rust@v0
with:
targets: 'x86_64-pc-windows-msvc,x86_64-pc-windows-gnu'
```
## Installing Cargo binaries
If you require `cargo-make`, `cargo-nextest`, or other global binaries, this action supports

8
action.yml
View file

@ -13,16 +13,16 @@ inputs:
description: 'Name of the target profile to cache.'
default: 'debug'
channel:
description: 'Toolchain specification/channel to install.'
description: 'Toolchain specification/channel to explicitly install.'
components:
description: 'Comma-separated list of additional components to install.'
inherit-toolchain:
description: 'Inherit all toolchain settings from the rust-toolchain.toml file.'
default: false
targets:
description: 'Comma-separated list of additional targets to install.'
profile:
description: 'Profile to install. Defaults to "minimal".'
inherit-toolchain:
description: 'Inherit all toolchain settings from the rust-toolchain.toml file.'
default: false
outputs:
cache-key:
description: 'The generated cache key used.'