peter-evans/slash-command-dispatch
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update readme with token scope details for orgs

Browse Source
This commit is contained in:
Peter Evans
2022-08-17 12:35:46 +09:00
parent 71e68e5b4a
commit df55ff2c7d
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3
View File
@@ -91,6 +91,9 @@ This action creates [repository_dispatch](https://docs.github.com/en/actions/ref
The default `GITHUB_TOKEN` does not have scopes to create these events, so a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required. The default `GITHUB_TOKEN` does not have scopes to create these events, so a `repo` scoped [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) is required.
If you will be dispatching commands to public repositories *only* then you can use the more limited `public_repo` scope. If you will be dispatching commands to public repositories *only* then you can use the more limited `public_repo` scope.
When using the action in a GitHub organization, the user the PAT is created on must be a member of the organization.
Additionally, the PAT should be given the `org:read` scope.
#### `reaction-token` #### `reaction-token`
If you don't specify a token for `reaction-token` it will use the default `GITHUB_TOKEN`. If you don't specify a token for `reaction-token` it will use the default `GITHUB_TOKEN`.