setup-rust-action/README.md

52 lines
1.7 KiB
Markdown
Raw Normal View History

# setup-rust-action
2019-08-15 17:16:59 +00:00
2019-08-16 00:16:04 +00:00
[![Integration status](https://github.com/hecrj/setup-rust-action/workflows/Integration/badge.svg)](https://github.com/hecrj/setup-rust-action/actions)
2019-08-15 17:16:59 +00:00
Sets up a specific Rust toolchain for use in your GitHub Actions workflows.
2019-08-15 17:16:59 +00:00
# Usage
2019-08-15 17:16:59 +00:00
Provide a `rust-version` with the desired toolchain version to install.
2019-08-15 23:49:38 +00:00
You can combine it with `matrix` to test different Rust toolchains in different
platforms!
```yml
2019-08-16 00:16:04 +00:00
name: Test Rust project
on: [push]
jobs:
test:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, windows-latest, macOS-latest]
rust: [stable, nightly]
steps:
2019-09-04 11:26:22 +00:00
- uses: hecrj/setup-rust-action@v1
with:
rust-version: ${{ matrix.rust }}
- uses: actions/checkout@master
- name: Run tests
run: cargo test --verbose
```
2019-10-27 23:03:46 +00:00
## inputs
The following inputs can be provided with the `jobs.<job_id>.steps.with` yaml key.
| Name | Required | Description | Type | Default |
|--------------|:--------:|--------------------------------------------------------|-------------------------|---------|
| rust-version | ✖ | The toolchain name, such as stable, nightly, or 1.8.0 | String | stable |
| components | ✖ | The toolchain components to install | String, comma-separated | |
| targets | ✖ | The toolchain targets to add | String, comma-separated | |
For more details, check out [`action.yml`].
[`action.yml`]: https://github.com/hecrj/setup-rust-action/blob/master/action.yml
# Contributing / Feedback
Contributions and feedback are welcome! Feel free to open any issues or pull
requests.