setup-rokit/README.md

33 lines
1.3 KiB
Markdown
Raw Normal View History

2022-07-18 03:55:50 +01:00
<div align="center">
<h1><code>setup-aftman</code></h1>
<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://discord.gg/w9Bc6xH7uC"><img src="https://img.shields.io/discord/834969350061424660?label=discord" alt="discord" /></a>
</p>
</div>
2022-11-09 03:27:35 +00:00
GitHub action to install and run [aftman](https://github.com/LPGhatguy/aftman); a toolchain manager.
2022-07-18 03:55:50 +01:00
## Usage
2023-08-03 16:25:22 +01:00
Use the latest released version of `aftman` with default parameters:
2022-07-18 03:55:50 +01:00
```yaml
steps:
2022-11-13 01:33:54 +00:00
- uses: ok-nick/setup-aftman@v0.3.0
2022-07-18 03:55:50 +01:00
```
For a list of default parameter values, [check here](https://github.com/ok-nick/setup-aftman/blob/main/action.yml#L5-L25).
2022-07-18 03:55:50 +01:00
### Advanced Usage
For more advanced cases, use the parameters below.
```yaml
steps:
- uses: ok-nick/setup-aftman@v0.3.0
with:
2023-06-19 15:37:00 +01:00
version: v1.0.0 # name of git tag in aftman (uses latest by default)
2023-08-04 00:59:32 +01:00
path: some_dir/my_project # path to project dir containing `aftman.toml` (uses current dir by default)
cache: true # whether to enable binary caching between runs (true by default)
2023-06-19 15:35:53 +01:00
token: ${{ github.token }} # GitHub token to bypass rate limit (passed by default)
```
2022-07-18 03:55:50 +01:00
## Credits
2022-07-18 03:57:36 +01:00
[@nezuo](https://github.com/nezuo) - Installing `aftman` using `gh`