GitHub RunWorkflow
CertifiedDispatch a workflow run
GitHub RunWorkflow
Dispatch a workflow run
Triggers a workflow_dispatch event for a workflow in the target repository. The authenticated token must be allowed to read the repository and run workflows on the selected ref.
type: io.kestra.plugin.github.actions.RunWorkflowExamples
Trigger a GitHub Action workflow manually.
id: run_github_action_workflow_flow
namespace: company.team
tasks:
- id: run_workflow
type: io.kestra.plugin.github.actions.RunWorkflow
oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
repository: your_owner/your_repository
workflowId: your_workflow_id
ref: your_branch_or_tag_name
inputs:
foo:bar
Properties
appInstallationToken string
GitHub App installation token
Installation access token generated by a GitHub App. Use this for repository-scoped app access instead of a user token.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150endpoint string
GitHub API endpoint
GitHub or GitHub Enterprise API base URL such as https://api.github.com or https://ghe.acme.com/api/v3. Set this when targeting GitHub Enterprise or a non-default API endpoint.
inputs object
Workflow inputs map
Key/value payload passed to workflow inputs. Property values are rendered before the dispatch request is sent
jwtToken string
GitHub JWT token
GitHub App JWT used for app-level authentication. Use this when the task should authenticate as the app rather than a user.
login string
GitHub login
GitHub login used with oauthToken for authenticated requests. Leave unset when authenticating with jwtToken or appInstallationToken.
oauthToken string
GitHub OAuth token
GitHub personal access token used for authenticated requests. Can be used alone or with login.
ref string
Workflow ref
Branch or tag name used to resolve the workflow file. This ref must exist in the target repository.
repository string
Target repository
Repository in owner/repo format containing the workflow. The authenticated token must have access to this repository.
workflowId string
Workflow ID or filename
Workflow identifier accepted by the GitHub API such as a numeric ID or a workflow filename like build.yml
