feat(reports): --report-md and automatic GITHUB_STEP_SUMMARY output - #1049
Closed
Chemaclass wants to merge 2 commits into
Closed
feat(reports): --report-md and automatic GITHUB_STEP_SUMMARY output#1049Chemaclass wants to merge 2 commits into
Chemaclass wants to merge 2 commits into
Conversation
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.
Member
Author
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤔 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_SUMMARYas Markdown on the job page.💡 Changes
--report-md <file>writes a Markdown summary: verdict with duration, counts table, and each failure's name,file:lineand message in a fenced block (ANSI stripped, Markdown specials escaped)$GITHUB_STEP_SUMMARYset 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--coverageran, slowest tests under--profile, and rows survive--parallelvia the shared report spool