Skip to content

Report test results in the CI run summary too #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jstayton merged 1 commit into from
Aug 27, 2026
Merged

Report test results in the CI run summary too #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,27 @@ jobs:
cache: 'npm'
- name: Install npm dependencies
run: npm install
- name: Report coverage
- name: Run tests
run: |
set -o pipefail
npm run test:coverage | tee "$RUNNER_TEMP/coverage.txt"
npm run test:coverage | tee "$RUNNER_TEMP/tests.txt"
# Reported in its own step so the summary is still written when the suite
# fails, which is when the test results are most worth reading. Node
# prints both its summary and the coverage report even on failure.
- name: Report test results & coverage
if: ${{ !cancelled() }}
run: |
{
echo '## Tests'
echo
echo '```'
grep -E '^ℹ (tests|suites|pass|fail|cancelled|skipped|todo|duration_ms) ' "$RUNNER_TEMP/tests.txt" | sed 's/^ℹ //'
echo '```'
echo
echo '## Test coverage'
echo
echo '```'
awk '/start of coverage report/{f=1;next} /end of coverage report/{f=0} f' "$RUNNER_TEMP/coverage.txt" | sed 's/^ℹ //'
awk '/start of coverage report/{f=1;next} /end of coverage report/{f=0} f' "$RUNNER_TEMP/tests.txt" | sed 's/^ℹ //'
echo '```'
} >> "$GITHUB_STEP_SUMMARY"
- name: Upload coverage report
Expand Down
4 changes: 2 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ code in this repository.
- `npm test -- --watch` — re-run tests on file change.
- `npm run test:coverage` — run the suite with coverage, printing a report and
writing `coverage/lcov.info`. CI runs this in a separate job that posts the
report to the run summary and uploads it as an artifact. There is no
threshold: coverage is reported, not enforced.
test results and coverage report to the run summary and uploads the report as
an artifact. There is no threshold: coverage is reported, not enforced.
- `node --test src/main.test.js` — run a single test file. Add
`--test-name-pattern '<regex>'` to filter by test name.
- `npm run lint` — Prettier format check + ESLint. `npm run lint:format:fix` and
Expand Down