fix(operations,readme): the smoke check counts every suite, not the first one - #67
Merged
Merged
Conversation
…irst one Cutting v0.2.0 by following the release runbook literally is what found this. Smoke check 1 told the releaser to run node checks/check.test.mjs in the unpacked tarball and to expect "the self-tests green". That sentence was true when it was written, at v0.1.0: one file held the whole gate suite. PR #61 split it in three, and nothing came back to the runbook, so the command proves 78 of the 236 tests the gate job runs while the sentence still claims all of them. A check that overstates its own coverage is worse than no check, because it is the one a releaser trusts at the moment they stop looking. The fix is not to type the two missing filenames. That would restore the same sentence with the same clock running: the next split breaks it again, silently, and the next person to notice will also be someone who happened not to follow the instruction. So the step names no suite file at all now. It points at the gate job in .github/workflows/ci.yml, which is the list CI already keeps and the only copy that cannot drift from what actually runs, and it says out loud why the list is not repeated here, so a later editor does not helpfully inline it again. The README carried the same stale shape one sentence long, naming that single file as the way the checks test themselves. Same cause, same change: it now says every gate has to prove it fails on a violation and points at the workflow that runs those suites. Verified by following the new step in the published v0.2.0 tarball: it resolves to seven suites, 236 tests, all green, against 78 under the old wording. Traces-to: SC-6, SC-9
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.
What changed and why
Cutting v0.2.0 by following
docs/operations/deploy.mdliterally is what found this. Smoke check1 told the releaser to run
node checks/check.test.mjsin the unpacked tarball and to expect"the self-tests green". True at v0.1.0, when one file held the whole gate suite. PR #61 split it
in three and nothing came back to the runbook, so the command proves 78 of the 236 tests the
gatejob runs while the sentence still claims all of them.The fix is deliberately not "type the two missing filenames". That restores the same sentence
with the same clock running: the next split breaks it again, silently. The step now names no
suite file at all and points at the
gatejob in.github/workflows/ci.yml, the list CI alreadykeeps and the only copy that cannot drift from what actually runs. It also says why the list is
not repeated in the runbook, so a later editor does not helpfully inline it again.
README.mdcarried the same stale shape one sentence long, naming that single file as the waythe checks test themselves. Same cause, so it is in the same diff.
No behaviour changes and no gate moves: both files are prose.
Verified by
Following the new step literally, in the published v0.2.0 tarball, not in the working tree:
the instruction resolves to seven suites and all of them are green.
That is the before and after: 78 under the old wording, 236 under the new one, same tarball.
node checks/check.mjsgreen on this branch, and the link gate resolves the new pointer to.github/workflows/ci.yml.Not verifiable here: nothing. The change is one instruction and it was executed as written.