rust-toolchain/README.md
David Tolnay 0179615243
Replace 'ex.' abbreviation in readme
This was copied from the equivalent table in the readme of
actions-rs/toolchain, but is not common usage I think.
2022-02-13 19:43:02 -08:00

1.5 KiB

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@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 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.