docs(engineer): document the .simard-engineer-claim two-layer exclusion (#2621)#2646
Merged
Merged
Conversation
…on (#2621) Add a reference page describing the two-layer defense merged in #2623 that keeps the private per-worktree liveness sentinel (.simard-engineer-claim) from ever registering as an uncommitted change, so the engineer-loop pre-mutation guard cannot trip on it in a target repo that does not gitignore it: - Layer 1 (creation-time): exclude_engineer_claim() appends a root-anchored /.simard-engineer-claim to the worktree info/exclude. - Layer 2 (read-time): strip_claim_sentinel() drops the exact-root sentinel from every git-status consumer before worktree_dirty is computed. Documents the constant, both layers, security properties, and the pinning regression tests. Adds the page to the mkdocs nav. Docs-only; no code change. Refs #2621. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Summary
Docs-only follow-up to the merged fix for #2621 (delivered by #2623, commit
2c32fe65).Adds
docs/reference/engineer-claim-sentinel-exclusion.md, a reference page that documents the two-layer defense keeping Simard's private per-worktree liveness sentinel (.simard-engineer-claim) from ever registering as an uncommitted change — so the engineer-loop pre-mutation guard cannot trip on it in a target repo that does not gitignore the file.What it documents
?? .simard-engineer-claimuntracked entry madeworktree_dirty == true, aborting every mutating engineer withDirtyWorktreebefore the agent spawned, and driving the infinite re-dispatch loop.exclude_engineer_claim()appends a root-anchored/.simard-engineer-claimto the worktree'sinfo/exclude(resolved viagit rev-parse --git-path, idempotent, lock-guarded, non-fatal on failure).strip_claim_sentinel()drops the exact-root sentinel from everygit statusconsumer (inspect_workspace,verify_agent_spawn_artifacts) beforeworktree_dirtyis computed.ENGINEER_CLAIM_FILEsingle-source-of-truth constant, security properties, and the pinning regression tests intests_claim_sentinel.rs/tests_extra.rs.Scope
mkdocs.ymlnav entry.println!/eprintln!. No "Bridge" names.mkdocs build --strictpasses locally (no broken links / nav warnings).Refs #2621.