GithubActionReporter.md

---

GithubActionReporter

Utility class for Github actions.

• Full name: \Symfony\Component\Console\CI\GithubActionReporter

Constants

Constant	Visibility	Type	Value
ESCAPED_DATA	private		['%' => '%25', "\r" => '%0D', "\n" => '%0A']
ESCAPED_PROPERTIES	private		['%' => '%25', "\r" => '%0D', "\n" => '%0A', ':' => '%3A', ',' => '%2C']

Properties

output

private $output

---

Methods

__construct

public __construct(\Symfony\Component\Console\Output\OutputInterface $output): mixed

Parameters:

Parameter	Type	Description
$output	\Symfony\Component\Console\Output\OutputInterface

---

isGithubActionEnvironment

public static isGithubActionEnvironment(): bool

• This method is static.

---

error

Output an error using the Github annotations format.

public error(string $message, string $file = null, int $line = null, int $col = null): void

Parameters:

Parameter	Type	Description
$message	string
$file	string
$line	int
$col	int

See Also:

• https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-error-message -

---

warning

Output a warning using the Github annotations format.

public warning(string $message, string $file = null, int $line = null, int $col = null): void

Parameters:

Parameter	Type	Description
$message	string
$file	string
$line	int
$col	int

See Also:

• https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message -

---

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:

Parameter	Type	Description
$message	string
$file	string
$line	int
$col	int

See Also:

• https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-debug-message -

---

log

private log(string $type, string $message, string $file = null, int $line = null, int $col = null): void

Parameters:

Parameter	Type	Description
$type	string
$message	string
$file	string
$line	int
$col	int

---

---