Documentation
¶
Overview ¶
Package report renders engine findings as Markdown, JSON, or SARIF, and decides the process exit code from a --fail-on severity threshold.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Markdown ¶
Markdown renders the findings report: one table per rule, ordered by severity then id, listing only fail and unknown rows. scopeDesc describes the run (e.g. "12 repos + org") for the summary line.
func SARIF ¶
SARIF renders fail and unknown findings as a SARIF 2.1.0 log, uploadable to GitHub code scanning and usable as an audit evidence artifact.
func ShouldFail ¶
ShouldFail reports whether any finding fails at or above the threshold severity. threshold "none" never fails; "" defaults to "error". When failOnUnknown is set, an unknown finding at/above the threshold also fails — for the "the audit must be able to read everything" posture, so an under-scoped token can't slip a green build past the gate.
Source Files