Oliver/setup-rust-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #10 from softprops/better-docs

Browse Source 
document inputs in readme
This commit is contained in:
Héctor Ramón 2019-10-28 00:17:25 +01:00 committed by GitHub
commit a82cf6be2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -31,6 +31,16 @@ jobs:
run: cargo test --verbose
```
## 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