Skip to content

actions

Accessed as client.repos.actions; the async client mirrors it.

ReposActions

The repos.actions namespace.

artifacts

jobs

runners

runs

secrets

variables

workflows

tasks

tasks(
    owner: str,
    repo: str,
    *,
    page: int | None = None,
    limit: int | None = None,
    status: list[Literal["unknown", "waiting", "running", "success", "failure", "cancelled", "skipped", "blocked"]]
    | None = None,
) -> ActionTaskResponse

List a repository's action tasks.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
page int | None

page number of results to return (1-based)

None
limit int | None

page size of results, default maximum page size is 50

None
status list[Literal['unknown', 'waiting', 'running', 'success', 'failure', 'cancelled', 'skipped', 'blocked']] | None

Returns workflow tasks with the check run status or conclusion that is specified. For example, a conclusion can be success or a status can be in_progress.

None

Returns:

Type Description
ActionTaskResponse

TasksList.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. APIConflict is a conflict empty response.
UnprocessableEntityError
  1. APIValidationError is error format response related to input validation.

Operation ID: ListActionTasks

AsyncReposActions

The repos.actions namespace.

tasks

tasks(
    owner: str,
    repo: str,
    *,
    page: int | None = None,
    limit: int | None = None,
    status: list[Literal["unknown", "waiting", "running", "success", "failure", "cancelled", "skipped", "blocked"]]
    | None = None,
) -> ActionTaskResponse

List a repository's action tasks.

Parameters:

Name Type Description Default
owner str

owner of the repo

required
repo str

name of the repo

required
page int | None

page number of results to return (1-based)

None
limit int | None

page size of results, default maximum page size is 50

None
status list[Literal['unknown', 'waiting', 'running', 'success', 'failure', 'cancelled', 'skipped', 'blocked']] | None

Returns workflow tasks with the check run status or conclusion that is specified. For example, a conclusion can be success or a status can be in_progress.

None

Returns:

Type Description
ActionTaskResponse

TasksList.

Raises:

Type Description
BadRequestError
  1. APIError is error format response.
ForbiddenError
  1. APIForbiddenError is a forbidden error response.
NotFoundError
  1. APINotFound is a not found error response.
ConflictError
  1. APIConflict is a conflict empty response.
UnprocessableEntityError
  1. APIValidationError is error format response related to input validation.

Operation ID: ListActionTasks