Skip to content

Commit 83deae8

Browse files
committed
Update documentation
1 parent 279e84f commit 83deae8

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ See [examples](docs/examples.md) for command patterns and example workflows.
3030

3131
### Configuration
3232

33-
The following workflow should be configured in the repository where commands will be dispatched from. This example will respond to comments containing the slash commands `/rebase`, `/integration-test` and `/create-ticket`.
33+
The following workflow should be configured in the repository where commands will be dispatched from. This example will respond to comments containing the slash commands `/deploy`, `/integration-test` and `/create-ticket`.
3434

3535
```yml
3636
name: Slash Command Dispatch
@@ -45,7 +45,7 @@ jobs:
4545
uses: peter-evans/slash-command-dispatch@v1
4646
with:
4747
token: ${{ secrets.REPO_ACCESS_TOKEN }}
48-
commands: rebase, integration-test, create-ticket
48+
commands: deploy, integration-test, create-ticket
4949
```
5050
5151
This action also features [advanced configuration](docs/advanced-configuration.md) that allows each command to be configured individually if necessary. Use the standard configuration shown above unless you require advanced features.
@@ -78,7 +78,7 @@ This means that reactions to comments will appear to be made by the user account
7878
with:
7979
token: ${{ secrets.REPO_ACCESS_TOKEN }}
8080
reaction-token: ${{ secrets.GITHUB_TOKEN }}
81-
commands: rebase, integration-test, create-ticket
81+
commands: deploy, integration-test, create-ticket
8282
```
8383

8484
## Handling dispatched commands

docs/examples.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
- [Use case: Execute command using a specific repository branch](#execute-command-using-a-specific-repository-branch)
44
- [pytest](#pytest)
55
- [Use case: Execute command to modify a pull request branch](#execute-command-to-modify-a-pull-request-branch)
6+
- [black](#black)
67

78
## Use case: Execute command using a specific repository branch
89

@@ -59,7 +60,7 @@ jobs:
5960
6061
### pytest
6162
62-
This is a real example that uses this pattern to execute the Python test tool `pytest` against a specific branch.
63+
This is a real example that uses this pattern to execute the Python test tool [pytest](https://github.com/pytest-dev/pytest/) against a specific branch.
6364
6465
```
6566
/pytest branch=develop -v -s
@@ -167,7 +168,7 @@ jobs:
167168
168169
### black
169170
170-
This is a real example that uses this pattern to format Python code using [black](https://github.com/psf/black).
171+
This is a real example that uses this pattern to format Python code using [Black](https://github.com/psf/black).
171172
172173
```
173174
/black
@@ -187,7 +188,7 @@ jobs:
187188
# Checkout the pull request branch
188189
- uses: actions/checkout@v2
189190
with:
190-
token: ${{ secrets.ACTIONS_BOT_TOKEN }}
191+
token: ${{ secrets.REPO_ACCESS_TOKEN }}
191192
repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }}
192193
ref: ${{ github.event.client_payload.pull_request.head.ref }}
193194

@@ -216,7 +217,7 @@ jobs:
216217
- name: Add reaction
217218
uses: peter-evans/create-or-update-comment@v1
218219
with:
219-
token: ${{ secrets.ACTIONS_BOT_TOKEN }}
220+
token: ${{ secrets.REPO_ACCESS_TOKEN }}
220221
repository: ${{ github.event.client_payload.github.payload.repository.full_name }}
221222
comment-id: ${{ github.event.client_payload.github.payload.comment.id }}
222223
reaction-type: hooray

0 commit comments

Comments
 (0)