CheckRun

class mobu.storage.github.CheckRun(github_storage, id, name, summary, details=None)

Bases: object

Manage GitHub check runs via the GitHub API.

Parameters:

• github_storage (GitHubStorage) – To interact with the github api

• id (int) – The GitHub API check run ID.

• name (str) – The name of the checkrun. This will also be output title.

• summary (str) – The output summary.

• details (str | None, default: None) – The output details

Methods Summary

fail(error)	Conclude a GitHub check run as a failure.
start([summary, details])	Update a GitHub check run to: in progress.
succeed([details])	Conclude a GitHub check run as a success.

Methods Documentation

async fail(error)

Conclude a GitHub check run as a failure.

Parameters:

error (str) – The error that occurred.

Return type:

None

async start(summary=None, details=None)

Update a GitHub check run to: in progress.

Parameters:

• summary (str | None, default: None) – The output summary to display.

• details (str | None, default: None) – Output details to display.

Return type:

None

async succeed(details=None)

Conclude a GitHub check run as a success.

Parameters:

details (str | None, default: None) – Output details to display.

Return type:

None