/dispatch-workflow

Trigger a workflow in another (or same) repository and wait for the job to finish.

Primary LanguageShellMIT LicenseMIT

Dispatch Workflow

A GitHub Action that triggers a workflow and waits for it to succeed before proceeding. Largely based off of Trigger Workflow and Wait.

Usages

Basic use with user-added secret called ACCESS_TOKEN:

- uses: ahmedaljazzar/dispatch-workflow@v0.1.0
  with:
    owner: username
    repo: reponame
    token: ${{ secrets.ACCESS_TOKEN }}
    event_type: ping

Use with default GITHUB_TOKEN and optional inputs:

- uses: ahmedaljazzar/dispatch-workflow@v0.1.0
  with:
    owner: username
    repo: reponame
    token: ${{ secrets.GITHUB_TOKEN }}
    event_type: ping
    client_payload: '{"ref": "master"}'
    wait_time: 5
    max_time: 120

Arguments

Name Required Default Description
owner true N/A Owner of the repo where the workflow is to be triggered.
repo true N/A The repo where the workflow is to be triggered.
token true N/A An access token with write permissions to repo.
event_type true N/A The event type parameter to be passed in the repository dispatch request.
client_payload false "{}" The client payload parameter to be passed in the repository dispatch request. Should be in the format '{"key1": "value1", "key2": "value2"}'.
wait_time false 10 Time to wait between workflow status checks, in seconds.
max_time false 60 Maximum time to wait for the workflow to finish before exiting, in seconds.