Skip to main content

Module github_annotations

Module github_annotations 

Source
Expand description

--format github-annotations: GitHub Actions workflow-command annotations (::error / ::warning / ::notice lines on stdout).

The per-kind titles and message templates were first ported from the bundled action’s jq renderers (action/jq/annotations-{check,dupes, health}.jq); the security emitter is net-new (the jq layer has no security annotations). This renderer is now the source of truth for fallow 3.4.2 and later. The action keeps the jq files as frozen legacy renderers for older binaries, so new issue kinds go here and not into the jq files. Messages are built with real newlines and escaped at the render boundary per the strict contract in super::github.

The renderer is value-driven: it consumes the same JSON envelope that --format json serializes, which is what makes fallow report --from <results.json> byte-identical to the direct format run.

Enums§

EnvelopeKind
Which JSON envelope family is being rendered. Mirrors the kind field on the --format json root plus the two aggregate shapes.

Functions§

render_annotations
Pure renderer: collect per-kind annotations, sort most-severe-first (severity, then path, then line), rebase paths onto the repo root, and append the trailing budget notice.