Report

Report on issues found during validation.

class gh_issue_validator.report.ValidationIssue(code, message, heading=None)

An issue found during validation.

Parameters:

• code (str)

• message (str)

• heading (str | None, default: None)

code: str

message: str

heading: str | None = None

property rich_message: str

Return a message with a bit of style.

class gh_issue_validator.report.ValidationReport(issues=<factory>)

A report of all issues found during validation.

Parameters:

issues (list[ValidationIssue], default: <factory>)

issues: list[ValidationIssue]

add_issue(issue)

Add an issue to the report.

Parameters:

issue (ValidationIssue)

Return type:

None

property is_failure: bool

Return True if validation found any issues.

property github_issue_message: str

Return a message for posting on a GitHub issue.