βΉοΈ Check the ci workflow in this repo to see a live example on how to use this action in your own workflow
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 repositorythat 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 |
βΉοΈ If you are targeting:
- Public repository: The PAT only needs
public_repo
scope - Private repository: The PAT needs
repo
scope and its owner needswrite
access in the target repository
To enable step debug logging, set the following secret in the repository that's running the workflow:
- Secret name:
ACTIONS_STEP_DEBUG
- value:
true