GithubActionReporter.php
78 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | namespace IAWP_SCOPED\Symfony\Component\Console\CI; |
| 12 | |
| 13 | use IAWP_SCOPED\Symfony\Component\Console\Output\OutputInterface; |
| 14 | /** |
| 15 | * Utility class for Github actions. |
| 16 | * |
| 17 | * @author Maxime Steinhausser <maxime.steinhausser@gmail.com> |
| 18 | * @internal |
| 19 | */ |
| 20 | class GithubActionReporter |
| 21 | { |
| 22 | private $output; |
| 23 | /** |
| 24 | * @see https://github.com/actions/toolkit/blob/5e5e1b7aacba68a53836a34db4a288c3c1c1585b/packages/core/src/command.ts#L80-L85 |
| 25 | */ |
| 26 | private const ESCAPED_DATA = ['%' => '%25', "\r" => '%0D', "\n" => '%0A']; |
| 27 | /** |
| 28 | * @see https://github.com/actions/toolkit/blob/5e5e1b7aacba68a53836a34db4a288c3c1c1585b/packages/core/src/command.ts#L87-L94 |
| 29 | */ |
| 30 | private const ESCAPED_PROPERTIES = ['%' => '%25', "\r" => '%0D', "\n" => '%0A', ':' => '%3A', ',' => '%2C']; |
| 31 | public function __construct(OutputInterface $output) |
| 32 | { |
| 33 | $this->output = $output; |
| 34 | } |
| 35 | public static function isGithubActionEnvironment() : bool |
| 36 | { |
| 37 | return \false !== \getenv('GITHUB_ACTIONS'); |
| 38 | } |
| 39 | /** |
| 40 | * Output an error using the Github annotations format. |
| 41 | * |
| 42 | * @see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-error-message |
| 43 | */ |
| 44 | public function error(string $message, string $file = null, int $line = null, int $col = null) : void |
| 45 | { |
| 46 | $this->log('error', $message, $file, $line, $col); |
| 47 | } |
| 48 | /** |
| 49 | * Output a warning using the Github annotations format. |
| 50 | * |
| 51 | * @see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message |
| 52 | */ |
| 53 | public function warning(string $message, string $file = null, int $line = null, int $col = null) : void |
| 54 | { |
| 55 | $this->log('warning', $message, $file, $line, $col); |
| 56 | } |
| 57 | /** |
| 58 | * Output a debug log using the Github annotations format. |
| 59 | * |
| 60 | * @see https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-a-debug-message |
| 61 | */ |
| 62 | public function debug(string $message, string $file = null, int $line = null, int $col = null) : void |
| 63 | { |
| 64 | $this->log('debug', $message, $file, $line, $col); |
| 65 | } |
| 66 | private function log(string $type, string $message, string $file = null, int $line = null, int $col = null) : void |
| 67 | { |
| 68 | // Some values must be encoded. |
| 69 | $message = \strtr($message, self::ESCAPED_DATA); |
| 70 | if (!$file) { |
| 71 | // No file provided, output the message solely: |
| 72 | $this->output->writeln(\sprintf('::%s::%s', $type, $message)); |
| 73 | return; |
| 74 | } |
| 75 | $this->output->writeln(\sprintf('::%s file=%s,line=%s,col=%s::%s', $type, \strtr($file, self::ESCAPED_PROPERTIES), \strtr($line ?? 1, self::ESCAPED_PROPERTIES), \strtr($col ?? 0, self::ESCAPED_PROPERTIES), $message)); |
| 76 | } |
| 77 | } |
| 78 |