GitHub Actions for asdf
A collection of asdf GitHub Actions for use in your workflows.
| Action | Use | Description |
|---|---|---|
install |
asdf-vm/actions/install@v2 |
Installs asdf & tools in .tool-versions.Plugins fetched from asdf-vm/asdf-plugins |
setup |
asdf-vm/actions/setup@v2 |
Only install asdf CLI. |
plugins-add |
asdf-vm/actions/plugins-add@v2 |
Only install plugins, not tools. |
plugin-test |
asdf-vm/actions/plugin-test@v2 |
Plugin author test automation. |
Usage
steps:
- name: Install asdf & tools
uses: asdf-vm/actions/install@v2To avoid breaking changes, use the full Semantic Version
vX.Y.Z. Below are the available version pinning options:
steps:
# Reference a specific commit (most strict, for the supply-chain paranoid)
- uses: asdf-vm/actions/install@2368b9d
# Reference a semver major version only (GitHub recommended)
- uses: asdf-vm/actions/install@v2
# Reference a semver version of a release (recommended)
- uses: asdf-vm/actions/[email protected]
# Reference a branch (most dangerous)
- uses: asdf-vm/actions/install@masterAutomatic Actions Updating
GitHub Dependabot has support for tracking GitHub Actions releases and automatically creating PRs with these updates.
# .github/dependabot.yml
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly" # Check for updates to GitHub Actions every weekActions
Install
Installs asdf & tools in .tool-versions. Plugins fetched from
asdf-vm/asdf-plugins
steps:
- uses: asdf-vm/actions/install@v2See action.yml inputs.
Plugin Test
Plugin author test automation
steps:
- uses: asdf-vm/actions/plugin-test@v2
with:
command: my_tool --versionSee action.yml inputs.
Setup
Only install asdf CLI.
Note: this Action is used internally by Install & Plugin Test, opt for those first.
steps:
- uses: asdf-vm/actions/setup@v2See action.yml inputs.
Plugins Add
Only install plugins, not tools.
Note: this Action is used internally by Install & Plugin Test, opt for those first.
steps:
- uses: asdf-vm/actions/plugins-add@v2See action.yml inputs.
Miscellaneous
Full Example Workflow
This example workflow demonstrates how to use the Install Action:
asdf-vm/actions/install@v2. It is taken from the
asdf-vm/asdf-plugin-template
repository.
# example .tool-versions
shellcheck 0.9.0
shfmt 3.6.0# https://github.com/asdf-vm/asdf-plugin-template/blob/main/template/.github/workflows/lint.yml
name: Lint
on:
push:
branches:
- main
pull_request:
jobs:
shellcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: asdf-vm/actions/install@v2
- run: scripts/lint.bash
# script runs Shellcheck, Shfmt etc installed by previous action
actionlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check workflow files
uses: docker://rhysd/actionlint:1.6.23
with:
args: -colorDocker Tricks
Using the default GitHub Action images may cause problems during plugin testing due to current asdf implementation constraints. If you experience issues, you can use Docker containers to reduce the variables of your environment.
jobs:
plugin_test:
strategy:
fail-fast: false
matrix:
container:
- alpine:latest
- centos:latest
- ubuntu:latest
runs-on: ubuntu-latest
container:
image: ${{ matrix.container }}
steps:
- uses: asdf-vm/actions/plugin-test@v2
with:
command: my_tool --version