Documentation
¶
Overview ¶
Package github provides an output formatter that emits GitHub Actions workflow commands (::error / ::warning / ::notice) so Leakwatch findings show up as inline annotations on pull requests and in the workflow run log.
The format is meant to be written to the Actions runner's stdout: workflow commands are only interpreted on the live command stream, so writing them to a file has no effect. For safety, this formatter NEVER emits the raw secret value — annotations render in the (often public) PR UI and run logs, so only the redacted value is shown regardless of any --show-raw setting.
Reference: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Formatter ¶
type Formatter struct{}
Formatter emits findings as GitHub Actions workflow commands.
func (*Formatter) FileExtension ¶
FileExtension returns the file extension for this format. Workflow commands are intended for stdout, not a file; ".txt" is returned to satisfy the Formatter contract.
Source Files