Skip to main content

Module github_summary

Module github_summary 

Source
Expand description

--format github-summary: GitHub Actions job-summary markdown, written by workflows as fallow ... --format github-summary >> "$GITHUB_STEP_SUMMARY".

Sections, ordering, and truncation caps are ported from the bundled action’s jq renderers (action/jq/summary-{check,dupes,health,audit, security,fix,combined}.jq). Deviations from the jq layer: em dashes in the jq templates render as plain hyphens (repo style rule), and the combined view’s dupes file links read GH_REPO / GITHUB_REPOSITORY and PR_HEAD_SHA / GITHUB_SHA (the jq layer read only the action-set GH_REPO / PR_HEAD_SHA), with the link path prefix coming from the path-rebase resolution instead of the action-set PREFIX env var.

Like the annotations renderer, this is value-driven over the --format json envelope, which keeps fallow report --from output byte-identical to the direct format run.

Structs§

LinkContext
Environment-derived context for the combined view’s dupes file links.

Functions§

print_fix_summary
Render the fix envelope’s job summary directly from fallow fix. The fix envelope has no kind field; fallow report --from reaches the same renderer via EnvelopeKind::Fix (resolved by field detection), while the live fallow fix command calls this entry point.
print_summary
Render and print the job-summary markdown for one envelope.
render_audit_summary
Port of summary-audit.jq.
render_check_summary
Port of summary-check.jq.
render_combined_summary
Port of summary-combined.jq.
render_dupes_summary
Port of summary-dupes.jq.
render_fix_summary
Port of summary-fix.jq.
render_health_summary
Port of summary-health.jq.
render_security_summary
Port of summary-security.jq.
render_summary
Pure renderer, dispatching on the envelope family.