Skip to content
activity

GitHub Action

Trigger Repository Dispatch

v2.0.2 Latest version

Trigger Repository Dispatch

activity

Trigger Repository Dispatch

GitHub action to trigger a repository_dispatch event

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Trigger Repository Dispatch

              
  uses: myrotvorets/[email protected]
Learn more about this action in myrotvorets/trigger-repository-dispatch-action

Choose a version

Trigger repository_dispatch Action

Triggers a repository_dispatch event for the given repository.

Inputs

Name Default Required? Description
token YES A Personal Access Token with repo scope
repo github.repository No The name of the repository to send the event (owner/repo)
type YES A custom webhook event name
payload No JSON payload with extra information about the webhook event that your action or workflow may use. GitHub API allows for a maximum of 10 top-level properties

Example usage

In the workflow that needs to trigger a repository_dispatch action:

      - name: Repository Dispatch
        uses: myrotvorets/[email protected]
        with:
          token: ${{ secrets.REPOSITORY_ACCESS_TOKEN }}
          repo: username/my-repo
          type: my-custom-event
          payload: '{ "ref": "${{ github.ref }}", "sha": "${{ github.sha }}" }'

A workflow that handles repository_dispatch action:

name: Repository Dispatch
on:
  repository_dispatch:
    types:
      - my-custom-event
jobs:
  handle-dispatch:
    runs-on: ubuntu-latest
    steps:
      - name: Print commit hash
        run: echo ${{ github.event.client_payload.sha }}

      - name: Checkout
        uses: actions/checkout@v2
        with:
          ref: ${{ github.event.client_payload.ref }}