Skip to content

README.md

Latest commit

 

History

History
43 lines (34 loc) · 1.37 KB

README.md

File metadata and controls

43 lines (34 loc) · 1.37 KB

Repository Dispatch

Creates a repository dispatch event.

This is a custom event you can describe which can in turn be used to trigger a workflow on the target repo.

Inputs

Input Required Default Description
token true A GitHub Personal Access Token which can access the target repo
owner true The owner of the repo to send the dispatch event to (eg ubio)
repository true The name of the repo to send the dispatch event to (eg my-repo)
event true The event type
payload false {} JSON payload with data that your target action or worklow may use

Example Usage

Usage (build action):

- name: Run
  uses: ubio/github-actions/repository-dispatch@master
  with:
    token: ${{ secrets.ACCESS_TOKEN }}
    owner: "github-owner"
    repository: "repo-name"
    event: "your-event"
    payload: '{"extra":"info"}'

Usage (optimised):

- name: Run
  uses: docker://automationcloud/repository-dispatch:latest
  with:
    token: ${{ secrets.ACCESS_TOKEN }}
    owner: "github-owner"
    repository: "repo-name"
    event: "your-event"
    payload: '{"extra":"info"}'