Skip to content
arrow-down-circle

GitHub Action

rs-workspace/rust-toolchain

v0.2.0 Latest version

rs-workspace/rust-toolchain

arrow-down-circle

rs-workspace/rust-toolchain

GitHub actions for installing rust toolchain

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: rs-workspace/rust-toolchain

              
  uses: rs-workspace/rust-toolchain@v0.2.0
Learn more about this action in rs-workspace/rust-toolchain

Choose a version

GitHub Super-Linter CI Check dist/ CodeQL Coverage

Rust Toolchain (GitHub Action)

GitHub actions for installing rust toolchain

Example Workflow

name: test suite
on: [push, pull_request]

jobs:
  test:
    name: cargo test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: rs-workflow/rust-toolchain@main
      - run: cargo test --all-features

This installs the stable version of rust with default profile. To customize this you need to pass the inputs:

Inputs

All inputs are optional

Name Description
toolchain Rust toolchain specifier e.g. stable, nightly, beta, nightly-2024-10-12, etc. Read More
profile The group of components to be installed. Read More
components The list of space seperated rust components. Read More
Example 
name: test suite
on: [push, pull_request]

jobs:
  test:
    name: cargo test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: rs-workflow/rust-toolchain@main
        with:
          toolchain: nightly-2024-10-12 # Optional; Defaults to stable
          profile: minimal # Optional; Defaults to default
          components: miri # Optional
      - run: cargo test --all-features

For another example see ci.yml

Outputs

No outputs are given when running this action

Summary

A Summary table is created with the version of rustc and rustup

License

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