GitHub Actions GetRun
CertifiedGet a workflow run
GitHub Actions GetRun
Get a workflow run
Fetches a GitHub Actions workflow run by id and returns its status, conclusion and metadata. Optionally includes the jobs of the run with their own status and conclusion. The token needs the actions: read permission.
type: io.kestra.plugin.github.actions.GetRunExamples
Get the status and jobs of a workflow run.
id: github_actions_get_run
namespace: company.team
tasks:
- id: get_run
type: io.kestra.plugin.github.actions.GetRun
oauthToken: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
repository: my-org/my-repo
runId: 123456789
includeJobs: true
- id: log_result
type: io.kestra.plugin.core.log.Log
message: "Run {{ outputs.get_run.runNumber }} is {{ outputs.get_run.status }} with conclusion {{ outputs.get_run.conclusion }}"
Properties
repository *string
Target repository
Repository in owner/repo format containing the workflow run.
runId *integerstring
Run ID
Numeric id of the workflow run, for example the runId output of RunWorkflow.
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.
includeJobs booleanstring
falseInclude jobs
When true, also returns the jobs of the run with their status and conclusion.
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.
Outputs
conclusion string
Conclusion
Run conclusion such as success or failure. Only set when the run is completed.
createdAt string
date-timeCreated at
When the run was created.
headSha string
Head SHA
Commit SHA the run was executed on.
htmlUrl string
Run URL
URL of the run on GitHub.
jobs array
Jobs
Jobs of the run with id, name, status and conclusion. Only set when includeJobs is true.
io.kestra.plugin.github.actions.GetRun-Job
Conclusion
Job conclusion such as success or failure. Only set when the job is completed.
Job ID
Id of the job.
Name
Name of the job.
Status
Job status such as queued, in_progress or completed.
runId integer
Run ID
Id of the workflow run.
runNumber integer
Run number
Sequential number of the run within the workflow.
status string
Status
Run status such as queued, in_progress or completed.
updatedAt string
date-timeUpdated at
When the run was last updated.
