Workflow¶

class github.Workflow.Workflow¶

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

id¶

Type:	int

name¶

Type:	string

path¶

Type:	string

state¶

Type:	string

created_at¶

Type:	datetime.datetime

updated_at¶

Type:	datetime.datetime

url¶

Type:	string

html_url¶

Type:	string

badge_url¶

Type:	string

create_dispatch(ref, inputs=NotSet)¶

Calls:	POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches
Parameters:	ref – `github.Branch.Branch` or `github.Tag.Tag` or `github.Commit.Commit` or string inputs – dict
Return type:	bool

get_runs(actor=NotSet, branch=NotSet, event=NotSet, status=NotSet, check_suite_id=NotSet)¶

Calls:	GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs
Parameters:	actor – `github.NamedUser.NamedUser` or string branch – `github.Branch.Branch` or string event – string status – string
Return type:	`github.PaginatedList.PaginatedList` of `github.WorkflowRun.WorkflowRun`