3
0
Fork 0
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
2023-01-21 10:24:52 -08:00
.github Time out workflows after 45 minutes 2022-11-25 18:56:18 -08:00
scripts Add 1.66.1 patch release 2023-01-10 17:45:53 -08:00
action.yml Also enable sparse registries with the _new_ environment variable 2023-01-21 10:45:57 -05:00
LICENSE Add MIT license 2021-10-09 02:41:20 +01:00
package-lock.json Dummy package jsons 2023-01-21 10:24:52 -08:00
package.json Dummy package jsons 2023-01-21 10:24:52 -08:00
README.md Make sure the 'ago' syntax specifies 'stable' 2022-09-25 07:56:42 -07:00

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

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, 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

Toolchain expressions

The following forms are available for projects that use a sliding window of compiler support.

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