Skip to content

Commit 9cd779f

Browse files
palfreyjthegedus
andauthored
docs: list all options for each Action (#588)
Co-authored-by: James Hegedus <jthegedus@hey.com>
1 parent 179e953 commit 9cd779f

File tree

2 files changed

+31
-9
lines changed

2 files changed

+31
-9
lines changed

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,14 @@ steps:
7979
- uses: asdf-vm/actions/install@v4
8080
```
8181

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

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

8691
### Plugin Test
8792

@@ -94,9 +99,18 @@ steps:
9499
command: my_tool --version
95100
```
96101

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

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

101115
### Setup
102116

@@ -110,9 +124,12 @@ steps:
110124
- uses: asdf-vm/actions/setup@v4
111125
```
112126

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

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

117134
### Plugins Add
118135

@@ -126,9 +143,14 @@ steps:
126143
- uses: asdf-vm/actions/plugins-add@v4
127144
```
128145

129-
<!-- TODO(jthegedus): capture action.yml options in a markdown table here. Show usage examples for each option. -->
146+
Options are:
147+
148+
| Name | Required | Default | Description |
149+
| -------------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------- |
150+
| asdf_branch | false | master (i.e. latest) | asdf branch to clone |
151+
| skip_install | false | false | setup env without installing asdf |
152+
| tool_versions | false | | If present, this value will be written to the .tool-versions file. |
130153

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

133155
## Miscellaneous
134156

install/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ inputs:
1212
before_install:
1313
description:
1414
Bash script to run after plugins are installed but before `asdf install`.
15-
eg, to install npm keyring
15+
e.g., to install npm keyring
1616
required: false
1717
asdf_branch:
1818
description: asdf branch to clone

0 commit comments

Comments
 (0)