-
-
Notifications
You must be signed in to change notification settings - Fork 0
GithubActionOutput
github-actions edited this page Apr 23, 2026
·
1 revision
Emits GitHub Actions workflow commands through the console output stream.
The helper becomes a no-op outside GitHub Actions, which lets callers route annotations and log groups through a single API without branching on the environment first.
- Full name:
\FastForward\DevTools\Console\Output\GithubActionOutput - This class is marked as final and can't be subclassed
- This class is a Final class
public __construct(\Symfony\Component\Console\Output\ConsoleOutputInterface $output): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$output |
\Symfony\Component\Console\Output\ConsoleOutputInterface | the console output used to emit workflow commands |
Closes any open group before the output instance is destroyed.
public __destruct(): mixedEmits an error annotation for the current workflow step.
public error(string $message, string|null $file = null, int|null $line = null, int|null $column = null): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | the annotation message |
$file |
string|null | the related file when known |
$line |
int|null | the related line when known |
$column |
int|null | the related column when known |
Emits a warning annotation for the current workflow step.
public warning(string $message, string|null $file = null, int|null $line = null, int|null $column = null): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | the annotation message |
$file |
string|null | the related file when known |
$line |
int|null | the related line when known |
$column |
int|null | the related column when known |
Emits a notice annotation for the current workflow step.
public notice(string $message, string|null $file = null, int|null $line = null, int|null $column = null): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | the annotation message |
$file |
string|null | the related file when known |
$line |
int|null | the related line when known |
$column |
int|null | the related column when known |
Emits a debug workflow command.
public debug(string $message): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$message |
string | the debug message |
Starts a collapsible GitHub Actions log group.
public startGroup(string $title): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$title |
string | the group title |
Ends the current collapsible log group.
public endGroup(): voidRuns a callback wrapped inside a GitHub Actions log group.
public group(string $title, callable $callback): \FastForward\DevTools\Console\Output\TResultParameters:
| Parameter | Type | Description |
|---|---|---|
$title |
string | the group title |
$callback |
callable | the callback to execute within the group |