Skip to content

Commit 66463e4

Browse files
committed
Update docs
1 parent aebc169 commit 66463e4

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@ A GitHub action to create a repository dispatch event.
66

77
## Usage
88

9+
Dispatch to the current repository by elivating the permissions of the default `GITHUB_TOKEN`.
10+
```yml
11+
permissions:
12+
actions: write
13+
14+
jobs:
15+
repositorydispatch:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Repository Dispatch
19+
uses: peter-evans/repository-dispatch@v2
20+
with:
21+
event-type: my-event
22+
```
23+
24+
Dispatch to a remote repository using a `repo` scoped GitHub [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
925
```yml
1026
- name: Repository Dispatch
1127
uses: peter-evans/repository-dispatch@v2
@@ -18,22 +34,23 @@ A GitHub action to create a repository dispatch event.
1834

1935
| Name | Description | Default |
2036
| --- | --- | --- |
21-
| `token` | (**required**) A GitHub access token with `actions: write` permission to the repository being dispatched. | |
37+
| `token` | (**required**) `GITHUB_TOKEN` (permissions `actions: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). See [token](#token) for further details. | `GITHUB_TOKEN` |
2238
| `repository` | The full name of the repository to send the dispatch. | `github.repository` (current repository) |
2339
| `event-type` | (**required**) A custom webhook event name. | |
2440
| `client-payload` | JSON payload with extra information about the webhook event that your action or workflow may use. | `{}` |
2541

2642
#### `token`
2743

28-
This action creates [`repository_dispatch`](https://developer.github.com/v3/repos/#create-a-repository-dispatch-event) events. The default `GITHUB_TOKEN`
29-
token can only be used if you are dispatching the same repo. In this case you must assign the permission `action: write` to the token, see [permissions api](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs). Example:
44+
This action creates [`repository_dispatch`](https://developer.github.com/v3/repos/#create-a-repository-dispatch-event) events.
45+
The default `GITHUB_TOKEN` token can only be used if you are dispatching the same repository that the workflow is executing in.
46+
In this case you must [elevate the token permissions](https://docs.github.com/en/actions/using-jobs/assigning-permissions-to-jobs) to allow the dispatch.
47+
3048
```yaml
3149
permissions:
3250
actions: write
3351
```
3452

35-
The solution to trigger other repositories is to manually create a [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) and store it as a secret e.g. `${{ secrets.PERSONAL_TOKEN }}`.
36-
53+
To dispatch to a remote repository you must create a [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with the `repo` scope and store it as a secret.
3754
If you will be dispatching to a public repository then you can use the more limited `public_repo` scope.
3855

3956
## Example

0 commit comments

Comments
 (0)