feat(reports): --report-md and automatic GITHUB_STEP_SUMMARY output by Chemaclass · Pull Request #1049 · TypedDevs/bashunit

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass · 2026-08-10T19:50:04Z

🤔 Background

Related #1015

Every existing report format targets a machine; there was no output aimed at the place a developer looks first — the pull-request page. GitHub renders anything appended to $GITHUB_STEP_SUMMARY as Markdown on the job page.

💡 Changes

New --report-md <file> writes a Markdown summary: verdict with duration, counts table, and each failure's name, file:line and message in a fenced block (ANSI stripped, Markdown specials escaped)
With $GITHUB_STEP_SUMMARY set and no explicit path, the summary is appended automatically; only the outermost run writes it, reusing the annotations claim marker so nested runs stay quiet
Coverage percentage appears when --coverage ran, slowest tests under --profile, and rows survive --parallel via the shared report spool
Flag wired through env default, validation (writable path fails fast), help, completions, docs and CHANGELOG

Write a human-readable Markdown summary aimed at the pull-request page: one-line verdict with total duration, a counts table, each failure's name, file:line and message in a fenced block with ANSI stripped, the coverage percentage when --coverage ran and the slowest tests under --profile. Inside GitHub Actions the summary is appended (never truncated) to GITHUB_STEP_SUMMARY automatically when no explicit path is given. Only the outermost run writes it, reusing the same claim marker as the stdout annotations, so nested runs stay quiet. Closes#1015

The reports is_enabled unit tests and every acceptance run that clears the top-level claim marker inherited the runner's real GITHUB_STEP_SUMMARY under CI: the unit tests flipped is_enabled on, and the un-claimed nested runs appended their fixtures' summaries to the actual job page.

Chemaclass · 2026-08-10T20:38:35Z

Superseded by #1043, which merged the same feature while this was in flight. The remaining salvageable piece — pinning GITHUB_STEP_SUMMARY='' in the claim-clearing gha-annotations acceptance runs so fixture summaries cannot land on the real job page — will come as a separate small PR.

Chemaclass added the enhancement New feature or request label Aug 10, 2026

Chemaclass self-assigned this Aug 10, 2026