GithubActionReporter
in package
Utility class for Github actions.
Tags
Table of Contents
- ESCAPED_DATA = ['%' => '%25', "\r" => '%0D', "\n" => '%0A']
- ESCAPED_PROPERTIES = ['%' => '%25', "\r" => '%0D', "\n" => '%0A', ':' => '%3A', ',' => '%2C']
- $output : mixed
- __construct() : mixed
- debug() : void
- Output a debug log using the Github annotations format.
- error() : void
- Output an error using the Github annotations format.
- isGithubActionEnvironment() : bool
- warning() : void
- Output a warning using the Github annotations format.
- log() : void
Constants
ESCAPED_DATA
private
mixed
ESCAPED_DATA
= ['%' => '%25', "\r" => '%0D', "\n" => '%0A']
Tags
ESCAPED_PROPERTIES
private
mixed
ESCAPED_PROPERTIES
= ['%' => '%25', "\r" => '%0D', "\n" => '%0A', ':' => '%3A', ',' => '%2C']
Tags
Properties
$output
private
mixed
$output
Methods
__construct()
public
__construct(OutputInterface $output) : mixed
Parameters
- $output : OutputInterface
Return values
mixed —debug()
Output a debug log using the Github annotations format.
public
debug(string $message[, string $file = null ][, int $line = null ][, int $col = null ]) : void
Parameters
- $message : string
- $file : string = null
- $line : int = null
- $col : int = null
Tags
Return values
void —error()
Output an error using the Github annotations format.
public
error(string $message[, string $file = null ][, int $line = null ][, int $col = null ]) : void
Parameters
- $message : string
- $file : string = null
- $line : int = null
- $col : int = null
Tags
Return values
void —isGithubActionEnvironment()
public
static isGithubActionEnvironment() : bool
Return values
bool —warning()
Output a warning using the Github annotations format.
public
warning(string $message[, string $file = null ][, int $line = null ][, int $col = null ]) : void
Parameters
- $message : string
- $file : string = null
- $line : int = null
- $col : int = null
Tags
Return values
void —log()
private
log(string $type, string $message[, string $file = null ][, int $line = null ][, int $col = null ]) : void
Parameters
- $type : string
- $message : string
- $file : string = null
- $line : int = null
- $col : int = null