Skip to content

Streamline CI and coverage collection #50

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 2 commits into from
Oct 8, 2026
Merged

Streamline CI and coverage collection #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52d26bb
Streamline CI and coverage collection
jstayton Oct 8, 2026
c49567d
Address CI review feedback
jstayton Oct 8, 2026
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
62 changes: 36 additions & 26 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,52 +6,59 @@ on:
- '**'
workflow_dispatch:

permissions:
contents: read

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
# Explicit bash enables pipefail so tee cannot hide test failures.
shell: bash

@jstayton jstayton Oct 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: This is what keeps pipefail on for the npm run test:coverage | tee step now that set -o pipefail is gone (the job log confirms bash --noprofile --norc -e -o pipefail). On ubuntu-latest it reads like a no-op, though, so I'd add a one-line comment saying why it's here. Otherwise someone will remove it and a failing suite will pass CI.

@jstayton jstayton Oct 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the comment in c49567d explaining that explicit bash enables pipefail so tee cannot hide test failures.


jobs:
lint-test:
name: Lint & test
runs-on: ubuntu-latest
timeout-minutes: 15
strategy:
fail-fast: false
matrix:
node-version: ['22.x', '24.x', '26.x']
node-version: ['22.x', '24.x']
include:
- node-version: '26.x'
is-primary: true
steps:
- name: Check out repository
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
- name: Set up Node.js v${{ matrix.node-version }}
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- name: Install npm dependencies
run: npm install
run: npm ci
- name: Run lint
if: matrix.is-primary
run: npm run lint
- name: Run typecheck
if: matrix.is-primary
run: npm run typecheck
- name: Run tests
if: ${{ !matrix.is-primary }}
run: npm test

test-coverage:
name: Test coverage
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
- name: Set up Node.js
uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
with:
node-version: '26.x'
cache: 'npm'
- name: Install npm dependencies
run: npm install
- name: Run tests
run: |
set -o pipefail
npm run test:coverage | tee "$RUNNER_TEMP/tests.txt"
- name: Run tests with coverage
if: matrix.is-primary
run: 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() }}
if:
${{ !cancelled() && matrix.is-primary &&
hashFiles('coverage/lcov.info') != '' }}
run: |
{
echo '## Tests'
Expand All @@ -67,8 +74,11 @@ jobs:
echo '```'
} >> "$GITHUB_STEP_SUMMARY"
- name: Upload coverage report
if: ${{ !cancelled() }}
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
if:
${{ !cancelled() && matrix.is-primary &&
hashFiles('coverage/lcov.info') != '' }}
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
with:
name: coverage
name: coverage-${{ github.run_attempt }}
path: coverage/
retention-days: 14
7 changes: 4 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ code in this repository.
tests live next to source as `*.test.js`).
- `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
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.
writing `coverage/lcov.info`. CI collects coverage during the Node 26 matrix
run, posts the 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
Loading