rayan/repository-dispatch
1
0
Fork 0
mirror of https://github.com/peter-evans/repository-dispatch.git synced 2026-06-24 05:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Peter Evans
2020-06-25 09:13:39 +09:00
parent 1c51dc3383
commit f540f114fd
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -26,9 +26,8 @@ A GitHub action to create a repository dispatch event.
#### `token`
This action creates [`repository_dispatch`](https://developer.github.com/v3/repos/#create-a-repository-dispatch-event) events.
The default `GITHUB_TOKEN` does not have scopes to do this so a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) is required.
If you will be dispatching to a public repository then you can use the more limited `public_repo` scope. Additionally, the user for which the PAT is created needs to have `write` access to the repository.
The default `GITHUB_TOKEN` does not have scopes to do this so a `repo` scoped [PAT](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) created on a user with `write` access to the target repository is required.
If you will be dispatching to a public repository then you can use the more limited `public_repo` scope.
## Example