Skip to content

Commit 4921e18

Browse files
committed
Update documentation
1 parent 80c21c2 commit 4921e18

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Check out the following demos.
2424
- [ChatOps Demo in Pull Requests](https://github.com/peter-evans/slash-command-dispatch/pull/8)
2525
- [Slash command code formatting - Python](https://github.com/peter-evans/slash-command-dispatch/pull/11)
2626

27-
See [examples](examples.md) for command patterns and example workflows.
27+
See [examples](docs/examples.md) for command patterns and example workflows.
2828

2929
## Dispatching commands
3030

31-
### Dispatch configuration
31+
### Configuration
3232

3333
This workflow should be configured in the repository where commands will be dispatched from.
3434

docs/advanced-configuration.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,6 @@ For example, the following basic configuration means that all commands must have
1717
1818
To solve this issue, advanced JSON configuration allows each command to be configured individually.
1919
20-
## Advanced action inputs
21-
22-
Advanced configuration requires a combination of yaml based inputs and JSON configuration.
23-
24-
| Input | JSON Property | Description | Default |
25-
| --- | --- | --- | --- |
26-
| `token` | | (**required**) A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
27-
| `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). | |
28-
| `reactions` | | Add reactions. :eyes: = seen, :rocket: = dispatched | `true` |
29-
| | `command` | (**required**) Input: A comma separated list of commands to dispatch. JSON property: A single command. | |
30-
| | `permission` | The repository permission level required by the user to dispatch commands. (`none`, `read`, `write`, `admin`) | `write` |
31-
| | `issue_type` | The issue type required for commands. (`issue`, `pull-request`, `both`) | `both` |
32-
| | `allow_edits` | Allow edited comments to trigger command dispatches. | `false` |
33-
| | `repository` | The full name of the repository to send the dispatch events. | Current repository |
34-
| | `event_type_suffix` | The repository dispatch event type suffix for the commands. | `-command` |
35-
| | `named_args` | Parse named arguments and add them to the command payload. | `false` |
36-
| `config` | | JSON configuration for commands. See [Advanced configuration](#advanced-configuration) | |
37-
| `config-from-file` | | JSON configuration from a file for commands. See [Advanced configuration](#advanced-configuration) | |
38-
3920
## Dispatching commands
4021
4122
There are two ways to specify JSON configuration for command dispatch. Directly in the workflow via the `config` input, OR, specifing a JSON config file via the `config-from-file` input.
@@ -102,3 +83,22 @@ jobs:
10283
token: ${{ secrets.REPO_ACCESS_TOKEN }}
10384
config-from-file: .github/slash-command-dispatch.json
10485
```
86+
87+
## Advanced action inputs
88+
89+
Advanced configuration requires a combination of yaml based inputs and JSON configuration.
90+
91+
| Input | JSON Property | Description | Default |
92+
| --- | --- | --- | --- |
93+
| `token` | | (**required**) A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
94+
| `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). | |
95+
| `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. | |
97+
| | `permission` | The repository permission level required by the user to dispatch commands. (`none`, `read`, `write`, `admin`) | `write` |
98+
| | `issue_type` | The issue type required for commands. (`issue`, `pull-request`, `both`) | `both` |
99+
| | `allow_edits` | Allow edited comments to trigger command dispatches. | `false` |
100+
| | `repository` | The full name of the repository to send the dispatch events. | Current repository |
101+
| | `event_type_suffix` | The repository dispatch event type suffix for the commands. | `-command` |
102+
| | `named_args` | Parse named arguments and add them to the command payload. | `false` |
103+
| `config` | | JSON configuration for commands. See [Advanced configuration](#advanced-configuration) | |
104+
| `config-from-file` | | JSON configuration from a file for commands. See [Advanced configuration](#advanced-configuration) | |

0 commit comments

Comments
 (0)