githubapp.event_check_run

Class to represents an Event Check Run, a wrapper to Github CheckRun

Module Contents

Classes

CheckRunConclusion	The CheckRun Conclusion
CheckRunStatus	The CheckRun Status
EventCheckRun	EventCheckRun

Data

ICONS_DEFAULT

API

class githubapp.event_check_run.CheckRunConclusion

Bases: enum.Enum

The CheckRun Conclusion

ACTION_REQUIRED

‘action_required’

CANCELLED

‘cancelled’

FAILURE

‘failure’

NEUTRAL

‘neutral’

SKIPPED

‘skipped’

STALE

‘stale’

SUCCESS

‘success’

TIMED_OUT

‘timed_out’

class githubapp.event_check_run.CheckRunStatus

Bases: enum.Enum

The CheckRun Status

COMPLETED

‘completed’

IN_PROGRESS

‘in_progress’

PENDING

‘pending’

QUEUED

‘queued’

REQUESTED

‘requested’

WAITING

‘waiting’

class githubapp.event_check_run.EventCheckRun(repository: github.Repository.Repository, name: str, sha: str)

EventCheckRun

This class represents a check run for a GitHub repository commit. It allows starting, updating and completing a check run.

Attributes:

• repository: The GitHub Repository object

• name: The name of the check run

• sha: The commit SHA being checked

• check_run: The GitHub CheckRun object, populated after starting the run

Methods:

• start: Starts a new check run

• update: Updates an in-progress check run

• complete: Completes a check run with a conclusion

Initialization

class SubRun(parent_check_run: githubapp.event_check_run.EventCheckRun, name: str, status: githubapp.event_check_run.CheckRunStatus = None, summary: str = None)

A “sub” check run.

If creates a sub check runs, they will be shown as a list in parent check run summary

Initialization

update(title: str = None, status: githubapp.event_check_run.CheckRunStatus = None, summary: str = None, conclusion: githubapp.event_check_run.CheckRunConclusion = None, update_check_run: bool = True) → None

Update a sub run

classmethod build_summary(sub_runs: list[SubRun]) → str

Build the summary of the sub runs

create_sub_run(name: str) → SubRun

Create a sub run

finish(title: str = None, status: githubapp.event_check_run.CheckRunStatus = None, summary: str = None, conclusion: githubapp.event_check_run.CheckRunConclusion = None, text: str = None, **output) → None

Finish the Check Run

icons

None

classmethod set_icons() → None

Set the CheckRun icon set from SUB_RUNS_ICONS env. :raises AttributeError: If the specified icon set is not found in the default configuration or if the icon set is not a string or a dictionary.

start(status: githubapp.event_check_run.CheckRunStatus = CheckRunStatus.WAITING, summary: str = None, title: str = None, text: str = None) → None

Start a check run

update(title: str = None, status: githubapp.event_check_run.CheckRunStatus = None, summary: str = None, conclusion: githubapp.event_check_run.CheckRunConclusion = None, text: str = None, **output) → None

Updates the check run

update_sub_runs(title: str = None) → None

Update the sub runs

githubapp.event_check_run.ICONS_DEFAULT

None