Documentation
¶
Overview ¶
Package render formats snapshots, evidence and reports for the CLI.
Index ¶
- Constants
- func Evidence(snap *types.PrSnapshot, inline []types.CommentEvidence, ...) string
- func Markdown(snap *types.PrSnapshot, inline []types.CommentEvidence, ...) string
- func NothingToClassify(snap *types.PrSnapshot) string
- func Report(snap *types.PrSnapshot, inline []types.CommentEvidence, ...) string
Constants ¶
const Marker = "<!-- review-replay -->"
Marker is the hidden HTML comment that lets an upsert (the Action) find and replace the previous review-replay comment instead of posting a new one.
Variables ¶
This section is empty.
Functions ¶
func Evidence ¶
func Evidence(snap *types.PrSnapshot, inline []types.CommentEvidence, issue []types.IssueLevelEvidence) string
Evidence prints the deterministic evidence packets for the snapshot.
func Markdown ¶ added in v0.2.0
func Markdown( snap *types.PrSnapshot, inline []types.CommentEvidence, issueLevel []types.IssueLevelEvidence, outcomes []types.Outcome, ) string
Markdown renders the classified report as a PR comment body (GitHub-flavored markdown). It leads with Marker so a sticky-comment upsert can locate it. Only the unresolved comments (pending / partial / needs-discussion) get a row; the addressed ones are summarized in the header.
func NothingToClassify ¶
func NothingToClassify(snap *types.PrSnapshot) string
NothingToClassify is shown when neither inline nor issue-level work survives filtering.
func Report ¶
func Report( snap *types.PrSnapshot, inline []types.CommentEvidence, issueLevel []types.IssueLevelEvidence, outcomes []types.Outcome, ) string
Report formats the full classified report with per-comment status, source and draft replies. inline + issueLevel are passed so we can look up the original body for the comment column.
Types ¶
This section is empty.
Source Files