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§
- Link
Context - Environment-derived context for the combined view’s dupes file links.
Functions§
- print_
fix_ summary - Render the fix envelope’s job summary (the fix envelope has no
kindfield, so it does not route throughEnvelopeKind). - 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.