Workflow

class github.Workflow.Workflow

This class represents Workflows.

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

The OpenAPI schema can be found at

  • /components/schemas/workflow

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

create_dispatch(ref: Branch | Tag | Commit | str, inputs: dict | _NotSetType = NotSet, throw: bool = False) → bool
Calls:

POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches

Note: raises or return False without details on error, depending on the throw parameter.

get_runs(actor: NamedUser | str | _NotSetType = NotSet, branch: Branch | str | _NotSetType = NotSet, event: str | _NotSetType = NotSet, status: str | _NotSetType = NotSet, created: str | _NotSetType = NotSet, exclude_pull_requests: bool | _NotSetType = NotSet, check_suite_id: int | _NotSetType = NotSet, head_sha: str | _NotSetType = NotSet) → PaginatedList[WorkflowRun]
Calls:

GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs

disable() → bool
Calls:

PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable

Return type:

bool

enable() → bool
Calls:

PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable

Return type:

bool