README.md

Action: Repository Dispatch

• Usage
  • Inputs
    • (*) token
• DEBUG

Usage

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

Inputs

• targetRepository: Full name (owner/repo-name) of the repository that will receive the repository_dispatch event.

  • required: false
  • default: ${{ github.repository }} (current repository running the workflow)

• eventType: Custom event type expected by the receiving repository

  • required: true
  • example: 'do-something-awesome'

• token: A GitHub Personal Access Token (PAT) (more info)

  • required: true

• payloadType: Type of payload provided. Types: string, path, url

  • required: false
  • default: 'string'

• payload: Stringified JSON payload. Expected when payloadType is not provided or provided as "string"

  • required: false
  • default: '{}'
    • example: '{"customField": "some value", "anotherField": "another value"}'

• payloadPath: Path to file with JSON payload. Expected when payloadType is provided as "path"

  • required: false

• payloadUrl: URL to JSON payload. Expected when payloadType is provided as "url"

  • required: false

(*) token

ℹ️ 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