Repository navigation
docs: add macOS system-mode upgrade steps - #703
LoopGlitch26 merged 2 commits into
Conversation
Signed-off-by: Siri-Durugapu <siridurugapu29@gmail.com>
LoopGlitch26
left a comment
There was a problem hiding this comment.
Thanks. The commands match what init does: the labels are install.V2_LABEL and install.HELPER_LABEL, and init's own bootout and bootstrap (tracekit/install.py:1636-1641 and :201-211) make step 3 right as written. Three small things:
- Please assert the helper's label too, since step 1 names it:
self.assertIn(f"sudo launchctl bootout system/{install.HELPER_LABEL}", upgrade). Then the docs also follow that label if it changes. - The rest of that list wraps at about 118 columns; please wrap steps 1, 3 and 4 the same way.
- Drop the blank line you added after
class DocCommands(unittest.TestCase):; the other classes in the file start their first method straight after the class line.
I approved the CI runs.
Signed-off-by: Siri-Durugapu <siridurugapu29@gmail.com>
|
Thanks for the review! I've addressed all three suggestions:
The focused regression test, full documentation test suite, and pyflakes lint all pass. I've pushed the updates to PR #703. Thanks for the feedback! |
|
Merged, thanks. The system-mode upgrade steps now give the macOS launchd commands next to the systemd ones, and a test keeps them on init's labels. It ships in the next release. If you'd like another one nearby: #464 lists more system-mode hints and help text that don't match what init does, and each item can be fixed on its own. A request: if you use a coding agent (Claude Code, Codex, Cursor, Gemini CLI or OpenCode), would you run Tracekit on it for a week, on your own projects? After a week, |
What and why
This updates the system-mode upgrade instructions to include the macOS
launchdcommands alongside the existing Linuxsystemdcommands.Previously, the upgrade instructions documented only Linux service-management commands, leaving macOS users without the corresponding steps to stop and restart the signer and stop the harness helper when
--harnessis enabled.This change:
launchctl bootout.--harnessis enabled.launchctl kickstart.install.V2_LABEL, ensuring the documentation stays aligned with the configured signer label.How I ran it as a user
This is a documentation-only change. I verified the documented macOS commands against the install configuration and ran the documentation test suite.
Regression test:
Output:
The regression test was also run against the original documentation before the documentation change. It failed because the macOS signer stop command was missing.
Full documentation test suite:
Output:
The macOS
launchctlcommands were verified against the configured install labels; the commands were not executed on a macOS host.Checklist
make checkpasses (lint, tests, build);make test-tstoo ifsdk/typescript/changedCHANGELOG.md)docs/threat-model-laptop.md,docs/threat-model-server.md) — not applicable; no runtime behaviour or security claims changedgit commit -s, seeCONTRIBUTING.md)Security invariants
Evidence format
core.sig_message,ledger.make_record, the v1 schema, how the verifier treats existing bundles) or the published v2 formatdocs/sample/andtests/fixtures/) still verify, and the change is called out above