Skip to content

docs: Document the action options #588

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jthegedus merged 2 commits into from
Mar 16, 2025
Merged

docs: Document the action options #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95d4308
docs: Document the action options
palfrey Feb 2, 2025
05db223
Merge branch 'master' into document-options
jthegedus Mar 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 30 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,14 @@ steps:
- uses: asdf-vm/actions/install@v4
```

<!-- TODO(jthegedus): capture action.yml options in a markdown table here. Show usage examples for each option. -->
Options are:

See [action.yml](install/action.yml) inputs.
| Name | Required | Default | Description |
| -------------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------- |
| asdf_branch | false | master (i.e. latest) | asdf branch to clone |
| skip_install | false | false | setup env without installing asdf |
| tool_versions | false | | If present, this value will be written to the .tool-versions file. |
| before_install | false | | Bash script to run after plugins are installed but before `asdf install`.<br><br>e.g., to install npm keyring |

### Plugin Test

Expand All @@ -94,9 +99,18 @@ steps:
command: my_tool --version
```

<!-- TODO(jthegedus): capture action.yml options in a markdown table here. Show usage examples for each option. -->
Options are:

See [action.yml](plugin-test/action.yml) inputs.
| Name | Required | Default | Description |
| ------------ | -------- | ----------------------------- | ------------------------------------------------------------------------- |
| asdf_branch | false | master (i.e. latest) | asdf branch to clone |
| skip_install | false | false | setup env without installing asdf |
| command | true | | Command used to test your plugin tool. Something with --version or --help |
| plugin | false | repository name without asdf- | Plugin name to use |
| version | false | latest | Tool version to test |
| giturl | false | current github repository | Plugin repository |
| gitref | false | current commit | Branch or commit from repository to test |
| github_token | false | github.token value | Token used to avoid rate limit when asdf calls the GitHub API |

### Setup

Expand All @@ -110,9 +124,12 @@ steps:
- uses: asdf-vm/actions/setup@v4
```

<!-- TODO(jthegedus): capture action.yml options in a markdown table here. Show usage examples for each option. -->
Options are:

See [action.yml](setup/action.yml) inputs.
| Name | Default | Description |
| ------------ | -------------------- | --------------------------------- |
| asdf_branch | master (i.e. latest) | asdf branch to clone |
| skip_install | false | setup env without installing asdf |

### Plugins Add

Expand All @@ -126,9 +143,14 @@ steps:
- uses: asdf-vm/actions/plugins-add@v4
```

<!-- TODO(jthegedus): capture action.yml options in a markdown table here. Show usage examples for each option. -->
Options are:

| Name | Required | Default | Description |
| -------------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------- |
| asdf_branch | false | master (i.e. latest) | asdf branch to clone |
| skip_install | false | false | setup env without installing asdf |
| tool_versions | false | | If present, this value will be written to the .tool-versions file. |

See [action.yml](plugins-add/action.yml) inputs.

## Miscellaneous

Expand Down
2 changes: 1 addition & 1 deletion install/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ inputs:
before_install:
description:
Bash script to run after plugins are installed but before `asdf install`.
eg, to install npm keyring
e.g., to install npm keyring
required: false
asdf_branch:
description: asdf branch to clone
Expand Down