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 are 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). 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§

print_annotations
Render and print the annotation stream for one envelope, resolving the ambient path-rebase and package-manager options at this boundary.
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.