mathze/Workflow Dispatch Action
Triggers a workflow and retrieves the run-id and also supports waiting on it to complete.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| owner | Organization or user under which the repository of the workflow resist. Defaults to current owner. | no | — |
| repo | Name of the repository the workflow resist in. Defaults to current repository | no | — |
| token | The token used to work with the API. The token must have repo scope. Because this token is also used to trigger dispatch event, you can not use the GITHUB_TOKEN as explained here https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token. | yes | — |
| fail-on-error | Defines if the action should result in a build failure, if an error was discovered. Defaults to `false`. You can use the `failed` output to check for errors. | no | false |
| workflow-name | Name of the workflow to trigger. Can be the name of the workflow or its ID. | no | — |
| ref | The git reference for the workflow. The reference can be a branch or tag name. Defaults to default branch of the repository. | no | — |
| payload | Json-String representing any payload/input that shall be sent with the dispatch event. | no | — |
| trigger-timeout | Maximum time to use to getting workflow run id. Defaults to 1 minute. | no | — |
| trigger-interval | Time to wait between consecutive tries to retrieve a workflow run id. Defaults to 1 second. | no | — |
| use-marker-step | Indicates that the action shall send a unique id (external_ref_id) within the `inputs` payload. To detect the correct workflow run, your target workflow has to have at first step, in the earliest job, the name of this id. Example: # ... inputs: external_ref_id: required: false # ... jobs: beforeAll: runs-on: ubuntu-latest steps: - name: $ { { github.event.inputs.external_ref_id } } # ... | no | false |
| run-id | Workflow run id for which to wait. If set, enables the wait mode. | no | — |
| wait-timeout | Maximum time to use to wait until a workflow run completes. Defaults to 10 minutes. | no | — |
| wait-interval | Time to wait between consecutive queries on the workflow run status. Defaults to 1 second. | no | — |
| lookup-tolerance | Tolerance in seconds to account for server clock skew between the dispatch response time and the workflow run's created_at timestamp. | no | — |
Outputs
| name | description |
|---|---|
| failed | Indicates if there was an issue with the action run, and the workflow may not have been triggered correctly. [true, false] |
| run-id | The id of the started workflow run. May be empty if error or timeout occurred |
| run-status | The status of the triggered workflow. (Normally always 'completed') Only set through the wait mode. May be empty if no run was found or on error. |
| run-conclusion | The conclusion of the triggered workflow. Only set through the wait mode. May be empty if no run was found or on error. |