You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,15 +18,22 @@ A GitHub action to create a repository dispatch event.
18
18
19
19
| Name | Description | Default |
20
20
| --- | --- | --- |
21
-
| `token` | (**required**) A `repo` scoped GitHub [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). See [token](#token) for further details. | |
21
+
| `token` | (**required**) A GitHub access token with `actions: write` permission to the repository being dispatched. | |
22
22
| `repository` | The full name of the repository to send the dispatch. | `github.repository` (current repository) |
| `client-payload` | JSON payload with extra information about the webhook event that your action or workflow may use. | `{}` |
25
25
26
26
#### `token`
27
27
28
-
This action creates [`repository_dispatch`](https://developer.github.com/v3/repos/#create-a-repository-dispatch-event) events.
29
-
The default `GITHUB_TOKEN` does not have scopes to do this so a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) created on a user with `write` access to the target repository is required.
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:
30
+
```yaml
31
+
permissions:
32
+
actions: write
33
+
```
34
+
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
+
30
37
If you will be dispatching to a public repository then you can use the more limited `public_repo` scope.
0 commit comments