Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dtolnay/rust-toolchain
Concise GitHub Action for installing a Rust toolchain
https://github.com/dtolnay/rust-toolchain
Last synced: about 10 hours ago
JSON representation
Concise GitHub Action for installing a Rust toolchain
- Host: GitHub
- URL: https://github.com/dtolnay/rust-toolchain
- Owner: dtolnay
- License: mit
- Created: 2020-05-02T18:28:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T17:37:38.000Z (3 months ago)
- Last Synced: 2024-10-29T18:11:41.637Z (15 days ago)
- Language: Shell
- Homepage:
- Size: 265 KB
- Stars: 1,133
- Watchers: 12
- Forks: 53
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Install Rust Toolchain
This GitHub Action installs a Rust toolchain using rustup. It is designed for
one-line concise usage and good defaults.
## Example workflow
```yaml
name: test suite
on: [push, pull_request]
jobs:
test:
name: cargo test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- 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/[email protected]" pulls in
1.42.0.
## Inputs
All inputs are optional.
Name
Description
toolchain
Rustup toolchain specifier e.g. stable, nightly, 1.42.0, nightly-2022-01-01.
Important: the default is to match the @rev as described above.
When passing an explicit toolchain as an input instead of @rev, you'll want to use "dtolnay/rust-toolchain@master" as the revision of the action.
targets
Comma-separated string of additional targets to install e.g. wasm32-unknown-unknown
components
Comma-separated string of additional components to install e.g. clippy, rustfmt
## Outputs
Name
Description
cachekey
A short hash of the installed rustc version, appropriate for use as a cache key. "20220627a831"
name
Rustup's name for the selected version of the toolchain, like "1.62.0". Suitable for use with cargo +${{steps.toolchain.outputs.name}}.
## Toolchain expressions
The following forms are available for projects that use a sliding window of
compiler support.
```yaml
# Installs the most recent stable toolchain as of the specified time
# offset, which may be written in years, months, weeks, or days.
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable 18 months ago
```
```yaml
# Installs the stable toolchain which preceded the most recent one by
# the specified number of minor versions.
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable minus 8 releases
```
## License
The scripts and documentation in this project are released under the [MIT
License].
[MIT License]: LICENSE