PHPFUI/InstaDoc
 
Copied!

Utility class for Github actions.

CloneableInstantiable
Methods
public __construct(Symfony\Component\Console\Output\OutputInterface $output)
public debug(string $message, ?string $file = NULL, ?int $line = NULL, ?int $col = NULL) : void
 

Output a debug log using the Github annotations format.

  • see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-debug-message
public error(string $message, ?string $file = NULL, ?int $line = NULL, ?int $col = NULL) : void
 

Output an error using the Github annotations format.

  • see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
public static isGithubActionEnvironment() : bool
public warning(string $message, ?string $file = NULL, ?int $line = NULL, ?int $col = NULL) : void
 

Output a warning using the Github annotations format.

  • see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message
Constants
private Symfony\Component\Console\CI\GithubActionReporter::ESCAPED_DATA = ['%' => '%25', ' ' => '%0D', ' ' => '%0A']
 
  • see https://github.com/actions/toolkit/blob/5e5e1b7aacba68a53836a34db4a288c3c1c1585b/packages/core/src/command.ts#L80-L85
private Symfony\Component\Console\CI\GithubActionReporter::ESCAPED_PROPERTIES = ['%' => '%25', ' ' => '%0D', ' ' => '%0A', ':' => '%3A', ',' => '%2C']
 
  • see https://github.com/actions/toolkit/blob/5e5e1b7aacba68a53836a34db4a288c3c1c1585b/packages/core/src/command.ts#L87-L94
Properties
private Symfony\Component\Console\Output\OutputInterface $output
Methods
private log(string $type, string $message, ?string $file = NULL, ?int $line = NULL, ?int $col = NULL) : void
Methods
public static isGithubActionEnvironment() : bool
© 2025 Bruce Wells