rust-toolchain/README.md

59 lines
1.4 KiB
Markdown
Raw Normal View History

2021-10-09 07:15:41 +03:00
# 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@v3
2021-10-09 07:15:41 +03:00
- 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.
<table>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td><code>toolchain</code></td>
2022-07-14 21:23:14 +03:00
<td>
Rustup toolchain specifier e.g. <code>stable</code>, <code>nightly</code>, <code>1.42.0</code>, <code>nightly-2022-01-01</code>.
2022-07-14 21:23:14 +03:00
<b>Important: the default is to match the @rev as described above.</b>
</td>
</tr>
<tr>
<td><code>target</code></td>
<td>Additional target support to install e.g. <code>wasm32-unknown-unknown</code></td>
</tr>
<tr>
<td><code>components</code></td>
<td>Comma-separated string of additional components to install e.g. <code>clippy, rustfmt</code></td>
</tr>
</table>
2021-10-09 07:15:41 +03:00
## License
The scripts and documentation in this project are released under the [MIT
License].
[MIT License]: LICENSE