Write down the checks that pass without proving anything - #29
Merged
Merged
Conversation
Every entry is a trap this repository actually sprang during the BootAgent
rename, paired with the check that catches it. Kept concrete on purpose —
a checklist of generic advice does not get run.
The two worth knowing before touching anything here:
- An unauthenticated e2e run reports a green 198 instead of 213 because
the download-page tests skip themselves once the release feed hits the
rate limit. Green, with the coverage missing exactly where a change to
the download path does its damage.
- The visual baselines did not fail on a rename that changed text inside
the captured region: the glyph delta fits under maxDiffPixels, which is
sized for the window edge. They would have kept showing the old product
name while reporting success. Related, --update-snapshots is a no-op on
a passing suite; =all is what rebuilds.
Also corrects the README, which claimed the product repository still carried
the old name. It has been renamed to MaimoryLab/BootAgent, so that sentence
had become false rather than merely stale. The remaining old-name references
in this repository are deliberate, and the README now says where that is
recorded instead of implying they are pending cleanup.
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
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.
A checklist of the traps this repository actually sprang during the BootAgent
rename, each paired with the check that catches it. Every entry earned its place
by catching something real, or by failing to and letting something through.
Kept specific to this repository on purpose. A checklist of generic advice does
not get run.
The two that matter most
An unauthenticated e2e run hides its most relevant coverage.
test:e2ereports a green
198 passedinstead of213once the release feed hits theunauthenticated rate limit:
site.spec.ts:371/:470skip themselves when norelease is visible, which is correct for a fork with no releases and
indistinguishable from a spent rate limit. The result is green with the
download-page coverage missing — exactly where a change to that path does its
damage. CI injects the token, so this only bites locally, which is where the
decision to push gets made.
A passing visual snapshot does not mean the baseline is current. The rename
changed the brand name rendered inside
ActivationConsole, well within thecaptured region, and all six baselines still passed: the glyph delta is smaller
than
maxDiffPixels: 1_500, a tolerance sized for the rounded window edge. Leftalone they would have kept showing the old product name while reporting success.
Related and easy to miss:
--update-snapshotsonly rewrites baselines forfailing tests, so on a passing suite it is a no-op that looks like it worked.
--update-snapshots=allis what rebuilds.Because the tolerance hides small text changes, a refresh here cannot be justified
by "the test failed, so I updated it". The checklist records how the rename's
refresh was actually checked — per-pixel, confirming zero residual below
y=40.Also covered
site.spec.ts:1213fails intermittently under parallel load for reasonsunrelated to anything you are likely to be changing.
happened: the rename's own audit named
src/lib/downloads.ts:48asmust-not-change, and the sweep changed it anyway, breaking the header's GitHub
link. The e2e suite caught it; the sweep did not. Exempt by path in the file
list, not by intention.
distinguish a deliberate survivor from an oversight.
describe what is visible inside the images.
convenient answer and editing a vendored file on it.
git mvof abinary did not re-encode it.
README
Also corrects the README, which said the product repository still carried the old
name. It has since been renamed to
MaimoryLab/BootAgent, so thatsentence had become false rather than merely stale, and the link now points at the
current slug. The remaining old-name references in this repository are deliberate;
the README now says where that is recorded instead of implying they are pending
cleanup.
Verified with
pnpm run build— 47 pages throughastro checkandvalidate-build.mjs. Docs and README only, no source or vendored data touched.