DevComp/setup-rokit
1
0
Fork 0
mirror of https://github.com/CompeyDev/setup-rokit.git synced 2024-12-12 04:30:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: document inputs and caveats

Browse source
This commit is contained in:
ok-nick 2023-12-30 00:22:08 -05:00
parent d999a66b29
commit bb3a375219
No known key found for this signature in database
GPG key ID: CFC1F23DFE7B706B
1 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -22,11 +22,30 @@ For more advanced cases, use the parameters below.
steps:
- uses: ok-nick/setup-aftman@v0.4.2
with:
version: v1.0.0 # name of git tag in aftman (uses latest by default)
path: some_dir/my_project # path to project dir containing `aftman.toml` (uses current dir by default)
cache: "false" # whether to enable binary caching between runs (false by default)
token: ${{ github.token }} # GitHub token to bypass rate limit (passed by default)
version: v1.0.0 # name of git tag in aftman (uses latest tag by default)
path: some_dir/my_project # path to project dir containing `aftman.toml` ("." (current dir) 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)
```
## Inputs
### `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`.
### `path`
The path to the directory containing the `aftman.toml` to install tools from. The default is the current directory (`.`).
### `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.
There are a few reasons you may choose to enable caching:
* Action runs often, causing the GitHub rate-limit to be reached
* A large amount of tools to install
* Server downloading from is slow
### `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.**
## Credits
[@nezuo](https://github.com/nezuo) - Installing `aftman` using `gh`