Repository navigation
docs(ci): four CI walkthroughs with a proof checker (P7-NODE-32) - #545
Merged
Merged
Conversation
Home lab, several projects, a team and agents. Host steps are text blocks with a proven-by test; scripts/docs/check-walkthroughs.py checks every nself ci command path and bare flag against the generated Reference and every proof against the repository, with a self-test over bad fixtures. refgen adds the four pages to the guides/ci sidebar block.
Contributor
Author
|
Folded into #543 (land/p7f-plugins) to land in one CI run. |
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.
Four CI walkthrough pages under
.github/wiki/guides/ci/, stacked on #543 (baseland/p7f-plugins).Walkthrough-Home-Lab.md: desk Mac coordinator in personal mode, Minis bynodes add --systemor pairing,xcodelabels andrequires.labels, reservations and battery, a personal VPS with a pinned host key, secret grants, what a sleeping Mini does, coordinator backup and the KEK.Walkthrough-Multiple-Projects.md:nodes projects add|remove|list, a VPS for one project, project-scopesched.overrides.labels, fairness andruns queue, cache namespaces,runs stats --project.Walkthrough-Team.md:serve --teamon its own box, roles and tokens, members through--coordinator, personal nodes staying personal,providers github init, public repos on hosted runners,policy protect,serve watchpolling.Walkthrough-Agents.md: CLI--detach/runs wait/evidence/runs follow, the three MCP loop tools, the confirmation round trip, HTTP routes and the NDJSON follow stream, one server per project, no status without--post-status,trust.machine_invoked_cap,--trust untrusted.Every host-dependent step is a
textblock with a<!-- proven-by: TestName -->line and a row in the page's "Proven by" table. Pages link the reference guides instead of copying tables.scripts/docs/check-walkthroughs.py(stdlib): eachnself ci ...line must name a command in the generated Reference command table, each flag on a barenself ciline must be in its flag table, each text block withnself cineeds a proven-by line, and every proof (Go testfunc Name(or tracked path) must exist.--self-testruns four bad fixtures (wrong subcommand, unknown root flag, missing proven-by, unknown test) and one good one.Verification (local, scoped)
python3 scripts/docs/check-walkthroughs.py --self-test: 5/5 fixtures behave.python3 scripts/docs/check-walkthroughs.py .github/wiki/guides/ci/Walkthrough-*.md: clean.bash .github/scripts/check-doc-commands.sh .github/wiki/guides/ci/Walkthrough-*.md: rc 0.go generate ./tools/refgen/...: only the guides/ci sidebar block changed (committed); Reference.md unchanged.203.0.113.0/24and example names.Notes for review
plugins/CI.mdhas no row for the barenself ci(nself_citool), althoughscripts/ci/ci-machine-surface.shasserts the tool exists. The Agents page names it from that script.--agent-addr,--api-addrand--agent-binary, which the commands accept.Ticket: P7-NODE-32