workflows

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

SyncAsync

ReposActionsWorkflows

The repos.actions.workflows namespace.

dispatch

dispatch(
    owner: str,
    repo: str,
    workflowfilename: str,
    *,
    inputs: dict[str, str] | None = None,
    ref: str,
    return_run_info: bool | None = None,
) -> DispatchWorkflowRun | None

Dispatches a workflow.

Parameters:

Name	Type	Description	Default
`owner`	`str`	owner of the repo	required
`repo`	`str`	name of the repo	required
`workflowfilename`	`str`	name of the workflow	required
`inputs`	`dict[str, str] \| None`	Input keys and values configured in the workflow file.	`None`
`ref`	`str`	Git reference for the workflow	required
`return_run_info`	`bool \| None`	Flag to return the run info	`None`

Returns:

Type	Description
`DispatchWorkflowRun \| None`	DispatchWorkflowRun is a Workflow Run after dispatching.

Raises:

Type	Description
`NotFoundError`	APINotFound is a not found error response.

Operation ID: DispatchWorkflow

AsyncReposActionsWorkflows