GithubActionsViolationFormat
in package
implements
ViolationFormat
FinalYes
Prints the violations as GitHub Actions workflow commands, which GitHub shows as annotations on a pull request.
Table of Contents
Interfaces
- ViolationFormat
- A format to report the problems found in the documentation source in, in addition to the log.
Properties
- $annotations : array<int, string>
- $details : AnnotationDetails
Methods
- __construct() : mixed
- finish() : void
- Called once at the end of the run, to write the collected violations wherever this format needs them, like the output of the command, a file or the API of a code review tool.
- report() : void
- escapeData() : string
- escapeProperty() : string
Properties
$annotations
private
array<int, string>
$annotations
= []
$details read-only
private
AnnotationDetails
$details
Methods
__construct()
public
__construct(AnnotationDetails $details) : mixed
Parameters
- $details : AnnotationDetails
finish()
Called once at the end of the run, to write the collected violations wherever this format needs them, like the output of the command, a file or the API of a code review tool.
public
finish(OutputInterface $output) : void
Parameters
- $output : OutputInterface
report()
public
report(Violation $violation) : void
Parameters
- $violation : Violation
escapeData()
private
static escapeData(string $data) : string
Parameters
- $data : string
Return values
stringescapeProperty()
private
static escapeProperty(string $property) : string
Parameters
- $property : string