Skip to content

iniva/action-repository-dispatch

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

7814e06 Β· Jun 23, 2022

History

40 Commits
May 28, 2022
May 27, 2022
May 28, 2022
Jun 13, 2021
Mar 13, 2021
Dec 31, 2020
Dec 31, 2020
Dec 31, 2020
Dec 31, 2020
Jun 23, 2022
Jun 23, 2022
Mar 13, 2021
Jun 23, 2022
Dec 31, 2020
Jun 23, 2022

Repository files navigation

CI for Repository Dispatch CI

Action: Repository Dispatch

Usage

ℹ️ Check the ci workflow in this repo to see a live example on how to use this action in your own workflow

Inputs

Input Description Required Default Comments
eventType Custom event type expected by the receiving repository βœ… example: 'do-something-awesome'
token A GitHub Personal Access Token (PAT) βœ… PAT requirements
targetRepository Full name (owner/repo-name) of the repository
that will receive the repository_dispatch event
❌ ${{ github.repository }} default: current repository running the workflow
payloadType Type of payload provided.

Types: string, path, url
❌ string --
payload Stringified JSON payload.
Expected when payloadType is not provided or provided as "string"
❌ '{}' example:
'{"customField": "some value", "anotherField": "another value"}'
payloadPath Path to file with JSON payload.
Expected when payloadType is provided as "path"
❌ example: path/to/valid.json
payloadUrl URL to JSON payload.
Expected when payloadType is provided as "url"
❌ example: https://example.com/to/valid.json

PAT requirements

ℹ️ If you are targeting:

  • Public repository: The PAT only needs public_repo scope
  • Private repository: The PAT needs repo scope and its owner needs write access in the target repository

DEBUG

To enable step debug logging, set the following secret in the repository that's running the workflow:

  • Secret name: ACTIONS_STEP_DEBUG
  • value: true