actions/rust-toolchain
actions/rust-toolchain
3
0
Fork 0
mirror of https://github.com/dtolnay/rust-toolchain.git synced 2024-11-21 16:29:32 +01:00
Code Issues Projects Activity Pipelines

Add readme

Browse source
This commit is contained in:
David Tolnay 2021-10-09 05:15:41 +01:00
parent cd924db82b
commit 7f2ec0f367
No known key found for this signature in database
GPG key ID: F9BA143B95FF6D82
1 changed files with 42 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md Normal file
View file

@ -0,0 +1,42 @@
# Install Rust Toolchain
This GitHub Action installs a Rust toolchain using rustup. It is designed for
one-line concise usage.
## Example workflow
```yaml
name: test suite
on: [push, pull_request]
jobs:
test:
name: cargo test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dtolnay/rust-toolchain@stable
- run: cargo test --all-features
```
The selection of Rust toolchain is made based on the particular @rev of this
Action being requested. For example "dtolnay/rust-toolchain@nightly" pulls in
the nightly Rust toolchain, while "dtolnay/rust-toolchain@1.42.0" pulls in
1.42.0.
## Inputs
All inputs are optional.
| Name | Description |
| ------------ | -----------------------------------------------------------------------------------------------------------------------------------|
| `toolchain` | Rustup toolchain specifier, ex. `stable`, `nightly`, `1.42.0`. **Important: the default is to match the @rev as described above.** |
| `target` | Additional target support to install, ex. `wasm32-unknown-unknown` |
| `components` | Comma-separated string of additional components to install, ex. `clippy, rustfmt` |
## License
The scripts and documentation in this project are released under the [MIT
License].
[MIT License]: LICENSE