Skip to content

Commit f1c0b59

Browse files
committed
Update documentation
1 parent 4921e18 commit f1c0b59

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,16 @@ jobs:
4848
commands: rebase, integration-test, create-ticket
4949
```
5050
51+
This action also features [advanced configuration](docs/advanced-configuration.md) that allows each command to be configured individually if necessary. Use the standard configuration above unless you require advanced features.
52+
5153
### Action inputs
5254
5355
| Input | Description | Default |
5456
| --- | --- | --- |
5557
| `token` | (**required**) A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
5658
| `reaction-token` | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
5759
| `reactions` | Add reactions. :eyes: = seen, :rocket: = dispatched | `true` |
58-
| `commands` | (**required**) Input: A comma separated list of commands to dispatch. JSON property: A single command. | |
60+
| `commands` | (**required**) A comma separated list of commands. | |
5961
| `permission` | The repository permission level required by the user to dispatch commands. (`none`, `read`, `write`, `admin`) | `write` |
6062
| `issue-type` | The issue type required for commands. (`issue`, `pull-request`, `both`) | `both` |
6163
| `allow-edits` | Allow edited comments to trigger command dispatches. | `false` |
@@ -65,8 +67,6 @@ jobs:
6567
| `config` | | JSON configuration for commands. See [Advanced configuration](docs/advanced-configuration.md) | |
6668
| `config-from-file` | | JSON configuration from a file for commands. See [Advanced configuration](docs/advanced-configuration.md) | |
6769

68-
This action also features [advanced configuration](docs/advanced-configuration.md) that allows each command to be configured individually if necessary.
69-
7070
### What is the reaction-token?
7171

7272
If you don't specify a token for `reaction-token` it will use the [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) supplied via `token`.
@@ -121,16 +121,16 @@ If the `named-args` input is set to `true`, any arguments that are prefixed in t
121121
For example, the slash command `/deploy branch=master env=prod some other args` will be set in the JSON payload as follows.
122122

123123
```json
124-
{
125-
"command": "deploy",
126-
"args": "branch=master env=prod some other args",
127-
"unnamed_args": "some other args",
128-
"branch": "master",
129-
"env": "prod",
130-
"arg1": "some",
131-
"arg2": "other",
132-
"arg3": "args"
133-
}
124+
"slash_command": {
125+
"command": "deploy",
126+
"args": "branch=master env=prod some other args",
127+
"unnamed_args": "some other args",
128+
"branch": "master",
129+
"env": "prod",
130+
"arg1": "some",
131+
"arg2": "other",
132+
"arg3": "args"
133+
}
134134
```
135135

136136
These named arguments can be accessed in a workflow as follows.

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ inputs:
99
reactions:
1010
description: 'Add reactions to comments containing commands.'
1111
commands:
12-
description: 'A comma separated list of commands to dispatch.'
12+
description: 'A comma separated list of commands.'
1313
required: true
1414
permission:
1515
description: 'The repository permission level required by the user to dispatch commands.'

docs/advanced-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Advanced configuration requires a combination of yaml based inputs and JSON conf
9393
| `token` | | (**required**) A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
9494
| `reaction-token` | | `GITHUB_TOKEN` or a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
9595
| `reactions` | | Add reactions. :eyes: = seen, :rocket: = dispatched | `true` |
96-
| | `command` | (**required**) Input: A comma separated list of commands to dispatch. JSON property: A single command. | |
96+
| | `command` | (**required**) The slash command. | |
9797
| | `permission` | The repository permission level required by the user to dispatch commands. (`none`, `read`, `write`, `admin`) | `write` |
9898
| | `issue_type` | The issue type required for commands. (`issue`, `pull-request`, `both`) | `both` |
9999
| | `allow_edits` | Allow edited comments to trigger command dispatches. | `false` |

0 commit comments

Comments
 (0)