Skip to content

Commit 1145934

Browse files
committed
Update README
1 parent 3efbd15 commit 1145934

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When a valid command is found it creates a repository dispatch event that includ
1111
### Why repository dispatch?
1212

1313
"ChatOps" with slash commands can work in a basic way by parsing the commands during `issue_comment` events and immediately processing the command.
14-
In repositories with a lot of activity, the workflow queue will get backed up very quickly if it is trying to handle new comments for commands, **and** process the commands themselves.
14+
In repositories with a lot of activity, the workflow queue will get backed up very quickly if it is trying to handle new comments for commands *and* process the commands themselves.
1515

1616
Dispatching commands to be processed elsewhere keeps the workflow queue moving quickly. It essentially allows you to run multiple workflow queues in parallel.
1717

@@ -46,7 +46,6 @@ jobs:
4646
with:
4747
token: ${{ secrets.REPO_ACCESS_TOKEN }}
4848
commands: rebase, integration-test, create-ticket
49-
repository: peter-evans/slash-command-dispatch-processor
5049
```
5150
5251
### Action inputs
@@ -55,9 +54,9 @@ jobs:
5554
| --- | --- | --- |
5655
| `token` | (**required**) A `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line). | |
5756
| `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). | |
58-
| `reactions` | Add reactions to comments containing commands. | `true` |
57+
| `reactions` | Add reactions. :eyes: = seen, :rocket: = dispatched | `true` |
5958
| `commands` | (**required**) A comma separated list of commands to dispatch. | |
60-
| `permission` | The permission level required by the user to dispatch commands. (`none`, `read`, `write`, `admin`) | `write` |
59+
| `permission` | The repository permission level required by the user to dispatch commands. (`none`, `read`, `write`, `admin`) | `write` |
6160
| `issue-type` | The issue type required for commands. (`issue`, `pull-request`, `both`) | `both` |
6261
| `allow-edits` | Allow edited comments to trigger command dispatches. | `false` |
6362
| `repository` | The full name of the repository to send the dispatch events. | Current repository |
@@ -93,10 +92,12 @@ This means that reactions to comments will appear to be made by the user account
9392

9493
### Advanced configuration
9594

96-
Using JSON configuration allows the options for each command to be customised.
95+
Using JSON configuration allows the options for each command to be specified individually.
9796

9897
Note that it's recommended to write the JSON configuration directly in the workflow rather than use a file. Using the `config-from-file` input will be slightly slower due to requiring the repository to be checked out with `actions/checkout` so the file can be accessed.
9998

99+
Here is an example workflow. Take care to use the correct property names. The JSON property names differ from the action inputs by using underscores in place of hyphens.
100+
100101
```yml
101102
name: Slash Command Dispatch
102103
on:

0 commit comments

Comments
 (0)