docs(tests/os): document the rig phase, and stop crediting the commit gate to the update phase - #878
Merged
Conversation
…ot the update phase's The README documented four phases and a five-phase `all`. `rig` — the leg that proves the other machine this image installs (#797 R4) — was missing from the phase list, from the `--phase` enumeration, and from the opening line, so the only way to find it was to read run.sh. Two accuracy fixes alongside it: - the update phase commits with `rauc status mark-good` and rolls off with `rauc status mark-bad booted`. It never calls `pithead doctor --json` — that gate belongs to the appliance's own boot path, and it is the provision phase that asserts it both ways. - the provision phase's reboot leg and commit-gate assertions were undocumented. No behaviour change; the code was already right.
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
tests/os/README.mddocumented four phases and a five-phaseall.rig— the leg that proves the other machine this image installs (#797 R4, already ondevelop-v2) — was missing from the phase list, from the--phaseenumeration, and from the opening line. The only way to find it was to readrun.sh.Two accuracy fixes came out of the same pass:
pithead doctor --json. It commits withrauc status mark-goodand rolls off withrauc status mark-bad booted(_commit_cmd/_rollback_cmdintests/os/run.sh, and the leg-2/leg-3 assertions that call them). The doctor gate belongs to the appliance's own boot path, and it is the provision phase that asserts it both ways — pass on a healthy still-syncing stack, refuse once monerod is stopped. The claim moved to the phase that actually makes it.pithead-boot, which is the assertion guarding a miner that sits dark after every power blip.Why it looked wrong
This started against an older cut of the branch, where the README still described
rugix-ctrland an "open leg / no SSH" Status section. That version was already replaced ondevelop-v2by fcb9184 and 4cba93f. Rebased ontodevelop-v2, the residual gap is what this PR fixes — no rewrite, no churn against the version that just landed.Verification
make lint-mdandmake lint-docs-voiceboth pass (this file is covered by each). Every claim in the diff is derived fromtests/os/run.shondevelop-v2; nothing else changed.No behaviour change — the code was already right, the doc was not.
🤖 Generated with Claude Code