rayan/repository-dispatch
1
0
Fork 0
mirror of https://github.com/peter-evans/repository-dispatch.git synced 2026-07-21 10:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove token elevation

Browse Source
This commit is contained in:
Peter Evans
2022-10-21 15:56:27 +09:00
parent 73f2fe9d70
commit 1f873ff42d
2 changed files with 2 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/ci.yml vendored
View File

@@ -14,7 +14,6 @@ on:
permissions: permissions:
pull-requests: write pull-requests: write
contents: write contents: write
actions: write
jobs: jobs:
build: build:

17
README.md
View File

@@ -6,15 +6,8 @@ A GitHub action to create a repository dispatch event.
## Usage ## Usage
Dispatch an event to the current repository by elivating the permissions of the default `GITHUB_TOKEN`. Dispatch an event to the current repository.
```yml ```yml
permissions:
actions: write
jobs:
repositorydispatch:
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch - name: Repository Dispatch
uses: peter-evans/repository-dispatch@v2 uses: peter-evans/repository-dispatch@v2
with: with:
@@ -34,7 +27,7 @@ Dispatch an event to a remote repository using a `repo` scoped [Personal Access
| Name | Description | Default | | Name | Description | Default |
| --- | --- | --- | | --- | --- | --- |
| `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` | | `token` | (**required**) `GITHUB_TOKEN` 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` |
| `repository` | The full name of the repository to send the dispatch. | `github.repository` (current repository) | | `repository` | The full name of the repository to send the dispatch. | `github.repository` (current repository) |
| `event-type` | (**required**) A custom webhook event name. | | | `event-type` | (**required**) A custom webhook event name. | |
| `client-payload` | JSON payload with extra information about the webhook event that your action or workflow may use. | `{}` | | `client-payload` | JSON payload with extra information about the webhook event that your action or workflow may use. | `{}` |
@@ -43,12 +36,6 @@ Dispatch an event to a remote repository using a `repo` scoped [Personal Access
This action creates [`repository_dispatch`](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event) events. This action creates [`repository_dispatch`](https://docs.github.com/en/rest/repos/repos#create-a-repository-dispatch-event) events.
The default `GITHUB_TOKEN` token can only be used if you are dispatching the same repository that the workflow is executing in. The default `GITHUB_TOKEN` token can only be used if you are dispatching the same repository that the workflow is executing in.
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.
```yaml
permissions:
actions: write
```
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. 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.
If you will be dispatching to a public repository then you can use the more limited `public_repo` scope. If you will be dispatching to a public repository then you can use the more limited `public_repo` scope.