ok-nick/setup-aftman

GitHub action to install and run aftman; a toolchain manager

setup-aftman

GitHub action to install and run aftman; a toolchain manager.

Usage

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.

Advanced

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)

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

In any case, it is recommended to benchmark before enabling this feature.

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 - Installing aftman using gh

setup-aftman's Issues

Release `v1.0.0`

setup-aftman has been stable for a long time. If there are no problems with v0.4.0, then I will update to v1.0.0

Aftman auth token should be set to the one given as an input

Right now it is using github.token instead of inputs.token which makes installation of any tools from private repositories fail.

`lune` no longer detected after updating to 0.4.0 / 0.4.1

https://github.com/Iron-Stag-Games/Lync/actions/runs/6242236709/job/16945829024

Aftman fails to install tools

It says that rojo was not installed before and asking me if I want to install it. I later tried aftman trust as well. Doesn't work.

I also tried using aftman.toml file to install the tools, which doesn't show any errors in this part. However, when I try to run it, it just spits out rojo: command cannot be found

Why do we need to save the `PATH` differently on PowerShell for Windows?

#1 was able to fix the issue, but we still don't fully understand why it needs to be this way. Maybe if we set the path via pwsh on all platforms we can remove the platform-specific steps?

Support tool caching

Some actions use github actions to cache installed dependencies, such as those installed through npm. It would be really good if setup-aftman can cache tools installed through aftman, but I'm not sure how this caching works, admittedly.

Test formatting in CI via Prettier