RunWorkflow

Trigger a GitHub Action workflow manually.

Trigger a GitHub Action workflow by creating a workflow dispatch event.

yaml
type: "io.kestra.plugin.github.actions.RunWorkflow"

Examples

Trigger a GitHub Action workflow manually.

yaml
id: run_github_action_workflow_flow
namespace: company.team

tasks:
  - id: run_workflow
    type: io.kestra.plugin.github.actions.RunWorkflow
    oauthToken: your_github_token
    repository: your_owner/your_repository
    workflowId: your_workflow_id
    ref: your_branch_or_tag_name
    inputs:
      foo:bar

Properties

inputs object

Optional inputs to be used for the workflow dispatch.

Map with optional inputs.

jwtToken string

GitHub JWT token

Does not requires additional fields to log-in

GitHub login

Requires additional field: oauthToken, to log-in

oauthToken string

GitHub oauthToken

GitHub Personal Access Token. In addition, can be used with login or by its own

ref string

Some reference name in the repository where the dispatch will occur.

Can be a branch or a tag.

repository string

Repository where the workflow will be dispatched.

The repository on which the workflow will be dispatched. Repository name must be in format owner/repo.

workflowId string

Workflow id to dispatch.

The workflow id to be dispatched.

​Run​Workflow

RunWorkflow