MCPcopy Index your code
hub / github.com/PyGithub/PyGithub / get_workflow_runs

Method get_workflow_runs

github/Repository.py:3740–3803  ·  view source on GitHub ↗

:calls: `GET /repos/{owner}/{repo}/actions/runs `_ :param actor: :class:`github.NamedUser.NamedUser` or string :param branch: :class:`github.Branch.Branch` or string :param event:

(
        self,
        actor: Opt[NamedUser] = NotSet,
        branch: Opt[Branch] = NotSet,
        event: Opt[str] = NotSet,
        status: Opt[str] = NotSet,
        exclude_pull_requests: Opt[bool] = NotSet,
        head_sha: Opt[str] = NotSet,
        created: Opt[str] = NotSet,
        check_suite_id: Opt[int] = NotSet,
    )

Source from the content-addressed store, hash-verified

3738 return github.Workflow.Workflow(self._requester, url=url)
3739
3740 def get_workflow_runs(
3741 self,
3742 actor: Opt[NamedUser] = NotSet,
3743 branch: Opt[Branch] = NotSet,
3744 event: Opt[str] = NotSet,
3745 status: Opt[str] = NotSet,
3746 exclude_pull_requests: Opt[bool] = NotSet,
3747 head_sha: Opt[str] = NotSet,
3748 created: Opt[str] = NotSet,
3749 check_suite_id: Opt[int] = NotSet,
3750 ) -> PaginatedList[WorkflowRun]:
3751 """
3752 :calls: `GET /repos/{owner}/{repo}/actions/runs <https://docs.github.com/en/rest/reference/actions#list-workflow-runs-for-a-repository>`_
3753 :param actor: :class:`github.NamedUser.NamedUser` or string
3754 :param branch: :class:`github.Branch.Branch` or string
3755 :param event: string
3756 :param status: string `queued`, `in_progress`, `completed`, `success`, `failure`, `neutral`, `cancelled`, `skipped`, `timed_out`, or `action_required`
3757 :param exclude_pull_requests: bool
3758 :param head_sha: string
3759 :param created: string Created filter, see https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates
3760 :param check_suite_id: int
3761
3762 :rtype: :class:`PaginatedList` of :class:`github.WorkflowRun.WorkflowRun`
3763 """
3764 assert is_optional(actor, (github.NamedUser.NamedUser, str)), actor
3765 assert is_optional(branch, (github.Branch.Branch, str)), branch
3766 assert is_optional(event, str), event
3767 assert is_optional(status, str), status
3768 assert is_optional(exclude_pull_requests, bool), exclude_pull_requests
3769 assert is_optional(head_sha, str), head_sha
3770 assert is_optional(created, str), created
3771 assert is_optional(check_suite_id, int), check_suite_id
3772
3773 url_parameters: dict[str, Any] = {}
3774 if is_defined(actor):
3775 if isinstance(actor, github.NamedUser.NamedUser):
3776 url_parameters["actor"] = actor._identity
3777 else:
3778 url_parameters["actor"] = actor
3779 if is_defined(branch):
3780 if isinstance(branch, github.Branch.Branch):
3781 url_parameters["branch"] = branch.name
3782 else:
3783 url_parameters["branch"] = branch
3784 if is_defined(event):
3785 url_parameters["event"] = event
3786 if is_defined(status):
3787 url_parameters["status"] = status
3788 if is_defined(exclude_pull_requests) and exclude_pull_requests:
3789 url_parameters["exclude_pull_requests"] = 1
3790 if is_defined(head_sha):
3791 url_parameters["head_sha"] = head_sha
3792 if is_defined(created):
3793 url_parameters["created"] = created
3794 if is_defined(check_suite_id):
3795 url_parameters["check_suite_id"] = check_suite_id
3796
3797 return PaginatedList(

Callers 6

test_no_parametersMethod · 0.80
testGetWorkflowRunsMethod · 0.80

Calls 3

is_optionalFunction · 0.90
is_definedFunction · 0.90
PaginatedListClass · 0.90

Tested by 4

test_no_parametersMethod · 0.64