DevComp/setup-rokit
1
0
Fork 0
mirror of https://github.com/CompeyDev/setup-rokit.git synced 2025-01-06 03:09:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(README): update README

Browse source
This commit is contained in:
Erica Marigold 2024-07-15 19:22:05 +05:30 committed by GitHub
parent 2082fd29d9
commit 734acb37c4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,42 +1,42 @@
<div align="center"> <div align="center">
<h1><code>setup-aftman</code></h1> <h1><code>setup-rokit</code></h1>
<p> <p>
<a href="https://github.com/ok-nick/setup-aftman/actions?query=workflow%3ACI"><img src="https://github.com/ok-nick/setup-aftman/workflows/CI/badge.svg" alt="CI" /></a> <a href="https://github.com/CompeyDev/setup-rokit/actions?query=workflow%3ACI"><img src="https://github.com/CompeyDev/setup-rokit/workflows/CI/badge.svg" alt="CI" /></a>
<a href="https://discord.gg/w9Bc6xH7uC"><img src="https://img.shields.io/discord/834969350061424660?label=discord" alt="discord" /></a> <!-- <a href="https://discord.gg/w9Bc6xH7uC"><img src="https://img.shields.io/discord/834969350061424660?label=discord" alt="discord" /></a> -->
</p> </p>
</div> </div>
GitHub action to install and run [aftman](https://github.com/LPGhatguy/aftman); a toolchain manager. GitHub action to install and run [rokit](https://github.com/rojo-rbx/rokit); a toolchain manager.
## Usage ## Usage
Use the latest released version of `aftman` with default parameters: Use the latest released version of `rokit` with default parameters:
```yaml ```yaml
steps: steps:
- uses: ok-nick/setup-aftman@v0.4.2 - uses: CompeyDev/setup-rokit@v0.1.0
``` ```
For a list of default parameter values, [check here](https://github.com/ok-nick/setup-aftman/blob/main/action.yml#L5-L20). For a list of default parameter values, [check here](https://github.com/CompeyDev/setup-rokit/blob/main/action.yml#L5-L20).
### Advanced ### Advanced
For more advanced cases, use the parameters below. For more advanced cases, use the parameters below.
```yaml ```yaml
steps: steps:
- uses: ok-nick/setup-aftman@v0.4.2 - uses: CompeyDev/setup-rokit@v0.4.2
with: with:
version: v1.0.0 # name of git tag in aftman (uses latest tag by default) version: v1.0.0 # name of git tag in rokit (uses latest tag by default)
path: some_dir/my_project # path to project dir containing `aftman.toml` ("." (current dir) by default) path: some_dir/my_project # path to project dir containing a `rokit.toml`, `aftman.toml`, or `foreman.toml` ("." (current dir) by default)
cache: false # whether to enable binary caching between runs (false by default) cache: false # whether to enable binary caching between runs (false by default)
token: ${{ github.token }} # GitHub token to bypass rate limit (${{ github.token }} set by default) token: ${{ github.token }} # GitHub token to bypass rate limit (${{ github.token }} set by default)
``` ```
## Inputs ## Inputs
### `version` ### `version`
The git tag of `aftman` to install from releases and use. By default this input will be assigned to the latest version of `aftman`. The git tag of `rokit` to install from releases and use. By default this input will be assigned to the latest version of `rokit`.
### `path` ### `path`
The path to the directory containing the `aftman.toml` to install tools from. The default is the current directory (`.`). The path to the directory containing the `rokit.toml` to install tools from. The default is the current directory (`.`).
### `cache` ### `cache`
Enable to cache tools installed by `aftman`, the default value of this input is `false`. Note, in many cases enabling this feature will slow down the `setup-aftman` action. Enable to cache tools installed by `rokit`, the default value of this input is `false`. Note, in many cases enabling this feature will slow down the `setup-rokit` action.
There are a few reasons you may choose to enable caching: There are a few reasons you may choose to enable caching:
* Action runs often, causing the GitHub rate-limit to be reached * Action runs often, causing the GitHub rate-limit to be reached
@ -46,8 +46,8 @@ There are a few reasons you may choose to enable caching:
In any case, it is recommended to benchmark before enabling this feature. In any case, it is recommended to benchmark before enabling this feature.
### `token` ### `token`
Set to a GitHub token to be used by `aftman` to increase the GitHub rate-limit. Note, these two options, `${{ github.token }}` and `${{ secrets.GITHUB_TOKEN }}`, are equivalent and passed by default. **Thus, you do not need to specify this parameter unless you are using a token different from the owner of the repository.** Set to a GitHub token to be used by `rokit` to increase the GitHub rate-limit. Note, these two options, `${{ github.token }}` and `${{ secrets.GITHUB_TOKEN }}`, are equivalent and passed by default. **Thus, you do not need to specify this parameter unless you are using a token different from the owner of the repository.**
## Credits ## Credits
[@nezuo](https://github.com/nezuo) - Installing `aftman` using `gh` [@nezuo](https://github.com/ok-nick) - Creating `setup-aftman` which `setup-rokit` is a fork of