rs-toolchain/README.md

rust-toolchain Action

This GitHub Action installs Rust toolchain.

Optionally it can set installed toolchain as a default and as an override for current directory.

Example workflow

on: [push]

name: build

jobs:
  check:
    name: Rust project
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: Install nightly
        uses: actions-rs/toolchain@v1
        with:
            toolchain: nightly
            override: true

      # `cargo check` command here will use installed `nightly`
      # as it set as an "override" for current directory

      - name: Run cargo check
        uses: actions-rs/cargo@v1
        with:
          command: check

See additional recipes here.

Inputs

Name	Required	Description	Type	Default
toolchain	✓	Toolchain name to use, ex. stable, nightly, nightly-2019-04-20	string
target		Additionally install specified target for this toolchain, ex. x86_64-apple-darwin	string
default		Set installed toolchain as a default toolchain	bool	false
override		Set installed toolchain as an override for the current directory	bool	false

Components

If you are going to install clippy, rustfmt or any other rustup component, it might not be available in latest nightly build; check out the actions-rs/components-nightly Action, which makes this process much easier.

Notes

As rustup is not installed by default for macOS environments at the moment (2019-09-13), this Action will try its best to install it before any other operations.