Skip to content

docs(service): scope unknown probes during launchd recovery - #8572

Open
atinseau wants to merge 3 commits into
lidge-jun:devfrom
atinseau:codex/docs-launchd-recovery-probe
Open

atinseau wants to merge 3 commits into
lidge-jun:devfrom
atinseau:codex/docs-launchd-recovery-probe

Conversation

@atinseau

@atinseau atinseau commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Repair guidance currently promises no further eviction whenever a launchd probe becomes unknown after bootstrap. That is accurate for the probe immediately after bootstrap. For an unchanged definition, however, a later recovery kickstart can succeed and its following unknown probe can still lead to another eviction. Scope the guarantee to the immediate probe and describe the recovery case in English, all seven translations and the architecture contract.

Addresses the remaining documentation finding from the now-merged #8456: #8456 (comment). This change documents the current installLaunchd control flow; it does not alter service recovery, health probe deadlines or credential locking.

Verification

Documentation-only validation at 227366c74f91237c4c4a00d6df8a56b1cab73910 after merging dev 46a3db0d755797ff2530da6bed2147268d64fef2:

  • The personal wording patch has the same stable patch ID before and after the base refresh. The relevant installLaunchd control flow is unchanged: immediate post-bootstrap unknown skips recovery; an unchanged-definition recovery kickstart can still be followed by unknown and another eviction/bootstrap.
  • bun run typecheck: no errors in 2,459 files. bun run privacy:scan, bun run structure:check and git diff --check --cached origin/dev (before the merge commit): pass.
  • cd docs-site && bun install --frozen-lockfile && bun run build: pass; 665 pages and 96,234 internal links checked.
  • Runtime tests were not repeated for this documentation-only PR, and no prior runtime run is presented as current-head validation. No manual full-CI workflow was dispatched. Fresh automated review and upstream CI are separate from these scoped checks.

Checklist

  • Scope stays focused and avoids unrelated cleanup.
  • Docs or release notes were updated when needed.
  • Security-sensitive changes were reviewed for secrets, auth, and unsafe defaults (documentation only).

Review readiness checklist

  • Required local validation passed; commands, results, and any full-suite exception are documented.
  • I pushed my PR to a recent dev commit (at most 10 behind; a maintainer may still ask for the exact tip before merge).
  • I resolved all correct Codex and CodeRabbit findings.
  • My PR is ready for review.

Ready for review based on the scoped checks above. Fresh automated review and upstream CI completion are separate requirements.

Summary by CodeRabbit

  • Documentation
    • Clarified launchd repair behavior when status checks cannot read state immediately after bootstrap, including the outcomes for accepted and rejected bootstraps.
    • Documented that an unreadable status check after a successful recovery kickstart may lead to another job removal.
    • Updated the guidance across supported language versions.

@github-actions

Copy link
Copy Markdown
Contributor

✅ Deterministic PR hygiene checks passed.

@github-actions github-actions Bot added documentation Improvements or additions to documentation review-ready labels Nov 11, 2026
@github-actions

github-actions Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

✅ READY

  • all PR quality gates passed; the review readiness checklist is complete.

Review readiness checklist

  • ✅ Required local validation passed; commands, results, and any full-suite exception are documented.
  • ✅ I pushed my PR to a recent dev commit (at most 10 behind; a maintainer may still ask for the exact tip before merge).
  • ✅ I resolved all correct Codex and CodeRabbit findings.
  • ✅ My PR is ready for review.

✅ 4/4 boxes ticked.

This pull request has been marked Ready for Review.
The review-ready label marks this PR as ready; review automation runs independently.
Maintainers notified: @lidge-jun @Ingwannu

Hygiene

✅ Deterministic PR hygiene checks passed.

@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The launchd repair documentation now specifies the outcomes of an unreadable status probe immediately after bootstrap. It also describes possible job removal after a successful recovery kickstart when a later probe cannot read state.

Changes: Launchd repair documentation

Layer / File(s) Summary
Document repair probe outcomes
docs-site/src/content/docs/reference/cli/lifecycle.md, docs-site/src/content/docs/{fr,ja,ko,ru,tr,zh-cn,zh-tw}/reference/cli/lifecycle.md, structure/ops/service-and-sidecars.md
The documentation limits the no-further-action rule to an unreadable probe immediately after bootstrap. It describes accepted and rejected bootstrap outcomes, and notes that a later unreadable probe after a successful recovery kickstart for an unchanged definition may lead to another job removal.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

  • lidge-jun/opencodex#8456: Changes launchd repair behavior and documentation for unreadable post-bootstrap probes; this PR revises the documented conditions.
  • lidge-jun/opencodex#8385: Changes launchd retry behavior during teardown, which relates to the bootstrap outcomes described here.
Merge Risk: Minimal · up to 6b529

This documentation-only change clarifies launchd repair probe behavior. It does not alter runtime behavior, and no merge-blocking risk remains.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title accurately and concisely describes the documentation change: it scopes unknown probes during launchd recovery. This matches the main change across the English, translated, and architecture d…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check

Explanation

The title accurately and concisely describes the documentation change: it scopes unknown probes during launchd recovery. This matches the main change across the English, translated, and architecture documentation.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between de0914a and 6b52907.

Files selected for processing: 9

  • docs-site/src/content/docs/fr/reference/cli/lifecycle.md
  • docs-site/src/content/docs/ja/reference/cli/lifecycle.md
  • docs-site/src/content/docs/ko/reference/cli/lifecycle.md
  • docs-site/src/content/docs/reference/cli/lifecycle.md
  • docs-site/src/content/docs/ru/reference/cli/lifecycle.md
  • docs-site/src/content/docs/tr/reference/cli/lifecycle.md
  • docs-site/src/content/docs/zh-cn/reference/cli/lifecycle.md
  • docs-site/src/content/docs/zh-tw/reference/cli/lifecycle.md
  • structure/ops/service-and-sidecars.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

@github-actions
github-actions Bot marked this pull request as draft November 12, 2026 10:07
@github-actions
github-actions Bot marked this pull request as ready for review November 12, 2026 10:08
@github-actions
github-actions Bot marked this pull request as draft November 13, 2026 02:07
@github-actions
github-actions Bot marked this pull request as ready for review November 13, 2026 02:08

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation review-ready

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants