Skip to content

Pipeline ci dispatch-and-wait

pipeline ci dispatch-and-wait - Wait for GitHub workflow runs to complete

Dispatch a workflow and wait for it to complete, or wait for an existing run.

This command is useful for CI orchestration when you need to trigger a workflow and wait for its completion before proceeding.

Flags

Flag Description
--workflow Workflow file name to dispatch
--ref Git ref to run workflow on (default: current branch)
--run-id Existing run ID to wait for (skips dispatch)
--timeout Timeout in seconds (default: 300)
--inputs Workflow inputs as JSON object

Notes

Expected Output:

  • Workflow dispatch confirmation message
  • Live progress display with status updates
  • Exit code 0 on success, 1 on failure

Examples

pipeline ci dispatch-and-wait --workflow ci-r2r-cli.yaml --ref main
pipeline ci dispatch-and-wait --run-id 12345678
pipeline ci dispatch-and-wait --workflow ci-r2r-cli.yaml --ref main --timeout 600

See Also


Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.