-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,32 @@ | ||
# setup-roc | ||
|
||
A GitHub Action to install Roc. | ||
|
||
## Usage | ||
|
||
Add the following step to a GitHub actions workflow file to install Roc. | ||
|
||
```yaml | ||
steps: | ||
- name: Install Roc | ||
uses: hasnep/setup-roc@main | ||
with: | ||
roc-version: nightly | ||
``` | ||
### Inputs | ||
- `roc-version` - The version of Roc to use, defaults to `nightly`. | ||
Mutually exclusive with the `roc-version-file` input. | ||
- `roc-version-file` - Path to the file containing the Roc version to use. | ||
Mutually exclusive with the `roc-version` input. | ||
- `token` - The token used to authenticate when fetching from GitHub. | ||
|
||
### Outputs | ||
|
||
- `roc-version` - The installed Roc version. | ||
- `roc-path` - The absolute path to the Roc executable. | ||
|
||
## Licence | ||
|
||
This repository is released under the [MIT licence](./LICENCE) and is based on the [actions/setup-python](https://github.com/actions/setup-python) repository which is also released under the [MIT licence](./LICENCE-actions-setup-python). |