Skip to content

Commit 6cac403

Browse files
docs: name syntax-equivalence (chrome) among the coverage uploaders
Its matrix row sets `coverage: true` and the job's Codecov step runs on that flag, so the list of suites to wait for was one short — and the sentence after it said everything unlisted cannot move the number. A contributor following it could read a coverage result as final while that job was still running.
1 parent 05b54f1 commit 6cac403

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,7 +718,7 @@ A report that measures rather than tests — performance, memory, a preview buil
718718

719719
**Do not read, chase, or act on coverage until every suite that uploads it has finished.** Coverage arrives in pieces: each test suite uploads its own flag as it completes, and the service recomputes the totals after every upload. Until the last one lands the number on the PR is a partial sum — it will show a large drop, the comment will be rewritten in place several times with different percentages, and a deficit at that moment means "some suites have not reported yet", not "you lost coverage". The report itself says so, naming how many uploads the head is still missing; **read that line before reading the percentage**, and treat a non-zero count as "not ready" no matter how alarming the number next to it. **A red coverage check while coverage changed is the normal state of a healthy PR mid-run** and is not a failure to fix.
720720

721-
**What you are waiting for is those suites, not the whole run.** The uploading suites are the jobs that call the coverage action in `.github/workflows/test.yml` — today `unit`, `integration`, `test262` and the `parser (css)` / `parser (html)` legs (`integration` is sharded, so it alone accounts for most of the uploads, and it is gated behind `lint`, `basic` and `unit`). Read the workflow rather than this list if they have moved. Everything else on the PR — benchmarks, code scanning, dependency review, preview publishing, type-coverage, the changeset echo — never uploads a coverage report and cannot move the number, so a coverage gap is safe to fix while they are still running or even while one of them is red. Waiting on them buys nothing.
721+
**What you are waiting for is those suites, not the whole run.** The uploading suites are the jobs that call the coverage action in `.github/workflows/test.yml` — today `unit`, `integration`, `test262`, `syntax-equivalence (chrome)` and the `parser (css)` / `parser (html)` legs — the other two browsers and `parser (js)` run their suites without coverage instrumentation, so they upload nothing (`integration` is sharded, so it alone accounts for most of the uploads, and it is gated behind `lint`, `basic` and `unit`). Read the workflow rather than this list if they have moved. Everything else on the PR — benchmarks, code scanning, dependency review, preview publishing, type-coverage, the changeset echo — never uploads a coverage report and cannot move the number, so a coverage gap is safe to fix while they are still running or even while one of them is red. Waiting on them buys nothing.
722722

723723
Once those suites are in, read the report; only then is a genuine patch gap worth adding a test for. Chasing an intermediate number costs a round of pointless commits and, worse, tempts changes to `lib/` that exist only to move a percentage.
724724

0 commit comments

Comments
 (0)