GitHub Action
setup-aftman
GitHub action to install and run aftman; a toolchain manager.
Use the latest released version of aftman
with default parameters:
steps:
- uses: ok-nick/[email protected]
For a list of default parameter values, check here.
For more advanced cases, use the parameters below.
steps:
- uses: ok-nick/[email protected]
with:
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)
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 path to the directory containing the aftman.toml
to install tools from. The default is the current directory (.
).
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
In any case, it is recommended to benchmark before enabling this feature.
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.
@nezuo - Installing aftman
using gh