WorkflowRun

class github.WorkflowRun.WorkflowRun

This class represents Workflow Runs.

The reference can be found here https://docs.github.com/en/rest/reference/actions#workflow-runs

The OpenAPI schema can be found at - /components/schemas/artifact/properties/workflow_run - /components/schemas/workflow-run

A CompletableGithubObject can be partially initialised (completed=False). Accessing attributes that are not initialized will then trigger a request to complete all attributes.

A partially initialized CompletableGithubObject (completed=False) can be completed via complete(). This requires the url to be given via parameter url or attributes.

With a requester where Requester.is_lazy == True, this CompletableGithubObjects is partially initialized. This requires the url to be given via parameter url or attributes. Any CompletableGithubObject created from this lazy object will be lazy itself if created with parameter url or attributes.

Parameters

  • requester – requester

  • headers – response headers

  • attributes – attributes to initialize

  • completed – do not update non-initialized attributes when True

  • url – url of this instance, overrides attributes[‘url’]

  • accept – use this accept header when completing this instance

cancel() → bool
Calls

POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel

rerun() → bool
Calls

POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun

rerun_failed_jobs() → bool
Calls

POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs

timing() → github.WorkflowRun.TimingData
Calls

GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing

delete() → bool
Calls

DELETE /repos/{owner}/{repo}/actions/runs/{run_id}

jobs(_filter: Opt[str] = NotSet) → PaginatedList[WorkflowJob]

:calls “GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs :param _filter: string latest, or all