It supports additional targets, components and profiles and handles all these small papercuts for you.
Table of Contents
- Example workflow
- The toolchain file
- Contribute and support
on: [push] name: build jobs: check: name: Rust project runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Install latest nightly uses: actions-rs/toolchain@v1 with: toolchain: nightly override: true components: rustfmt, clippy # `cargo check` command here will use installed `nightly` # as it is set as an "override" for current directory - name: Run cargo check uses: actions-rs/cargo@v1 with: command: check
||Toolchain name to use, ex.
||Additionally install specified target for this toolchain, ex.
||Set installed toolchain as a default toolchain||bool||false|
||Set installed toolchain as an override for the current directory||bool||false|
||Comma-separated list of the additional components to install, ex.
toolchain input is not marked as required
in order to support toolchain files. See the details below.
rustup versions can be fetched from the Action outputs:
||Rustc version hash||
rustc_hash output value can be used with actions/cache Action
to store cache for different Rust versions, as it is unique across different Rust versions and builds (including
This Action supports rustup profiles, which are can be used to speed up the workflow execution by installing the minimally required set of components, for example:
- name: Install minimal nightly uses: actions-rs/toolchain@v1 with: profile: minimal toolchain: nightly
This Action will automatically run
rustup self update if
profile input is set
and the installed
rustup version does not supports them.
In order to provide backwards compatibility for
there is no value for
profile input set by default,
which means that the
default profile is used by
(and that includes
You may want to consider using
profile: minimal to speed up toolchain installation.
- name: Install minimal stable with clippy and rustfmt uses: actions-rs/toolchain@v1 with: profile: minimal toolchain: stable components: rustfmt, clippy
As an extra perk,
rustup >= 1.20.0 is able to find the most recent
with the requested components available; next example is utilizing this feature
to install the minimal set of
nightly toolchain components with the
- name: Install minimal nightly with clippy and rustfmt uses: actions-rs/toolchain@v1 with: profile: minimal toolchain: nightly components: rustfmt, clippy
In case if
nightly toolchain is requested and one of the components is missing in
nightly release, this Action will attempt the downgrade till it find
the most recent
nightly with all components needed.
Note that this behavior will work only if the following two conditions apply:
- At least one component is provided in
Same to the
profile input, if installed
rustup does not supports "components",
it will be automatically upgraded by this Action.
The toolchain file
This Action supports toolchain files,
so it is not necessary to use
toolchain input anymore.
Input has higher priority, so if you are want to use toolchain file, you need to remove the input from the workflow file.
toolchain input or
rust-toolchain file are provided,
Action execution will fail.
This Action is distributed under the terms of the MIT license, see LICENSE for details.
Contribute and support
Any contributions are welcomed!
If you want to report a bug or have a feature request, check the Contributing guide.
You can also support author by funding the ongoing project work, see Sponsoring.