mirror of https://github.com/dtolnay/rust-toolchain.git synced 2024-11-25 09:39:32 +01:00

Concise GitHub Action for installing a Rust toolchain

Find a file

David Tolnay ac5882a3ab Merge pull request #10 from dtolnay/push Print git push command at end of update-revs.sh		2022-06-04 16:52:24 -07:00
.github/workflows	Update CI to actions/checkout@v3	2022-04-24 18:31:38 -07:00
scripts	Print git push command at end of update-revs.sh	2022-06-04 16:48:01 -07:00
action.yml	Move title of rustup install step into the run script	2022-06-04 16:41:30 -07:00
LICENSE	Add MIT license	2021-10-09 02:41:20 +01:00
README.md	Update example workflow in readme to actions/checkout@v3	2022-04-24 18:30:51 -07:00

README.md

Install Rust Toolchain

This GitHub Action installs a Rust toolchain using rustup. It is designed for one-line concise usage.

Example workflow

name: test suite
on: [push, pull_request]

jobs:
  test:
    name: cargo test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - 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 e.g. `stable`, `nightly`, `1.42.0`. Important: the default is to match the @rev as described above.
`target`	Additional target support to install e.g. `wasm32-unknown-unknown`
`components`	Comma-separated string of additional components to install e.g. `clippy, rustfmt`

License

The scripts and documentation in this project are released under the MIT License.