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 were first ported from the bundled action’s jq renderers (action/jq/summary-{check,dupes,health,audit, security,fix,combined}.jq). 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 (summary-fix.jq still serves fix on every version). 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§

render_fix_summary
Port of summary-fix.jq.
render_summary
Pure renderer, dispatching on the envelope family.