https://github.com/mkroening/rust-toolchain-toml

GitHub Action for installing Installs a Rust toolchain from a toolchain file (rust-toolchain.toml)
https://github.com/mkroening/rust-toolchain-toml

github-actions rust rust-toolchain rustup

Last synced: about 2 months ago
JSON representation

GitHub Action for installing Installs a Rust toolchain from a toolchain file (rust-toolchain.toml)

• Host: GitHub
• URL: https://github.com/mkroening/rust-toolchain-toml
• Owner: mkroening
• License: mit
• Created: 2023-06-21T09:59:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-05T14:15:03.000Z (6 months ago)
• Last Synced: 2024-10-16T12:33:20.879Z (3 months ago)
• Topics: github-actions, rust, rust-toolchain, rustup
• Homepage:
• Size: 26.4 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Install rust-toolchain.toml

This GitHub action installs the Rust toolchain specified in the specified [toolchain file (`rust-toolchain.toml`)](https://rust-lang.github.io/rustup/overrides.html#the-toolchain-file) using [`dtolnay/rust-toolchain`](https://github.com/dtolnay/rust-toolchain) and [yq](https://github.com/mikefarah/yq).

## Usage

```yaml

- uses: mkroening/rust-toolchain-toml@main

  with:

    # Path to the toolchain file.

    # Default: rust-toolchain.toml

    toolchain-file: ''

```

## Example workflow

```yaml

name: test suite

on: [push, pull_request]

jobs:

  test:

    name: cargo test

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - uses: mkroening/rust-toolchain-toml@main

      - run: cargo test --all-features

```

## Inputs

All inputs are optional.

  Name

  Description

  toolchain-file

  

    Path to a rust-toolchain.toml.

  

## Outputs

  Name

  Description

  cachekey

  A short hash of the installed rustc version, appropriate for use as a cache key. "20220627a831"

  name

  Rustup's name for the selected version of the toolchain, like "1.62.0". Suitable for use with cargo +${{steps.toolchain.outputs.name}}.

## License

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

License](LICENSE).