probegh

list_workflow_runs

List GitHub Workflow runs

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosreliably.activities.gh.probes
Namelist_workflow_runs
Returnmapping

Usage

JSON

{
  "name": "list-workflow-runs",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosreliably.activities.gh.probes",
    "func": "list_workflow_runs",
    "arguments": {
      "repo": ""
    }
  }
}

YAML

name: list-workflow-runs
provider:
  arguments:
    repo: ""
  func: list_workflow_runs
  module: chaosreliably.activities.gh.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
repostringYesRepository
branchstring“main”NoBranch
eventstring“push”NoTriggered EventSelect run that were triggered by this specific event
statusstring“in_progress”NoRun StatusSelect run that have this status
windowstring“5d”NoWindowSelect runs within the given time window only
actorstringnullNoActorSelect runs triggered by this actor
exclude_pull_requestsbooleanfalseNoExclude PR RunsExclude PR runs

Signature

def list_workflow_runs(
        repo: str,
        actor: Optional[str] = None,
        branch: str = 'main',
        event: str = 'push',
        status: str = 'in_progress',
        window: str = '5d',
        exclude_pull_requests: bool = False,
        configuration: Dict[str, Dict[str, str]] = None,
        secrets: Dict[str, Dict[str, str]] = None) -> Dict[str, Any]:
    pass