Files
zkxw/.agents/skills/personal-dev/references/worktree-lifecycle.md
zlwu 42301730ef chore(agents): 更新个人智能体至官方 main eb4c320
固定协议 6 安装内容与来源摘要,保留试点工程配置及既有授权,为合入 V2.0 提供可复现版本。
2026-11-02 11:59:53 +08:00

12 KiB
Raw Permalink Blame History

Worktree 生命周期与清理

本文件是登记、保留、回收 worktree 和任务分支的权威入口。默认每个已交付任务及时回收隔离目录,本地任务分支保留至少 7 天;失败、阻塞、等待用户验收和主动停止的任务保留原现场。由 Agent 调用 Git/宿主工具执行,不是后台清理器;不能把安装、台账状态或脚本检查通过当作已经删除。

创建/复用前先按路径与命名确定真实工程根、任务标识和归属;目录名不能代替下面的实际状态核对。

触发与授权

  • 创建或复用任务 worktree 时登记;普通工单交付及队列 queue-finish 成功后,进入下一单之前尝试清理本任务。
  • 每次用户启动/续接队列、普通任务开始时只读检查已登记的遗留项;队列在无当前单、有效占用的边界处理符合条件的项。持续模式每次合法唤醒也只读检查,最多每日一次且不重复提醒;idle/not_due 退出前只核对本地台账和目录,不联网、不删除、不把旧状态当成可删除证据;本轮有当前单时延后遗留删除,空闲唤醒不为清理另行启动队列或抢锁。
  • 已授权采用本流程时,自动清理当前任务所创建且通过检查的临时 worktree;沿用工程更严格限制。仅安装或升级不授权扫描后批量删除历史目录。发现未登记旧目录,只列清单,先核实归属并取得历史清理授权,再补登记;不能按目录前缀猜归属。
  • 用户停止或指定保留优先,停止后只保存检查点和保留原因。检查或清理失败不影响已完成的工单状态,不重新打开工单;记录待清理,可继续无依赖任务。磁盘不足等影响开发的环境故障另行停止并报告。

主目录台账

通过 Git 的 worktree list --porcelain -z 确定同仓库主工作目录,在其中 .local/agent/worktree-registry/<UUID>.json 保存每个隔离目录的独立记录,不能写在待删除 worktree 内。先验证路径没有符号链接越界、确属同工程、未被跟踪且已被 Git 忽略,目录 0700、文件 0600;失败则保留目录并报告。使用原子替换写入,同一记录只由核实后的唯一 owner 修改。它不是跨机器分布式锁。

最小记录内容(未知值为 null,不能预填检查通过):

字段 内容
version, id, repository 版本 1、随机 UUID、无凭据的仓库标识
issue, worktree, created_at 工单链接/编号、本机实际路径、带时区的创建时间;一个工单有多个目录时分别登记
owner, origin, artifact_id 创建会话/任务 ID,host 或 git,宿主附件 ID(如适用);已有创建证据定位
task_branch, task_commit, integration_branch, integration_commit 实际分支和完整提交,保留最终交付映射
state, reason, preserve active / retained / eligible / removing / removed / archived / missing,状态理由和用户保留标记
completed_at, branch_keep_until 真正交付完成时间及至少其后 7 天的本地分支保留截止时间
evidence, recovery, last_checked_at 工单/验收/主分支/环境/文件检查的证据定位,保留分支或宿主恢复标识,最近检查时间
branch_state, cleanup_result 分支 retained/deleted 及实际清理结果/失败原因、发生时间

不存密码、完整工单正文、图片或本地配置内容。只记录凭据来源定位,保护性副本仍按凭据规则保存,不能进入提交或通用压缩包。台账在删除前保存恢复依据,删除后更新结果;保留它及必要交付证据,不把 worktree 留作永久报告目录。宿主归档也保留恢复标识,不把归档当作无限空间;历史归档的彻底删除另依宿主及用户保留策略处理。

删除前的全部条件

每次操作前重新核对,eligible 仅是上次检查结果。任一条件不满足或无法确认,记为 retained 并说明原因:

  1. 交付已完成:按工单收尾取得真实验收、集成验证、远端同步、环境恢复和关单读回结果。完整运行时的普通单与队列单均完成 queue-finish;未建立远端占用的遗留普通单可用 delivery-check;未安装运行时的 Skill-only 普通单按 completion.md 完成同等实时证据的人工核对并标明方式,不能把现有脚本失败改称 Skill-only 绕过。用户自测未通过不符合。PR 模式另按PR 证据规则读回确已合并;closed 未合并或仍待合并的 PR 保留目录。再次核对关联工单未重开、最新反馈无未处理问题,目标远端提交可达且本地已同步;网络失败不能沿用旧成功记录。
  2. 归属与占用明确:目标是登记的同仓库 linked worktree,实际分支/提交与任务记录一致;不是主目录、共享工作区、其他活跃会话、用户保留或 Git locked 项。按工单占用核对远端 owner/阶段/资源、所有本地 worker 与台账,不能把本会话 current 为空当作其他会话没有使用。核对宿主附件及其他任务引用,路径改用、新分支、脱离预期仓库时保留。当前 shell 先切到主目录;当前会话仍必须在该目录继续执行或宿主无法安全解除占用时,延后清理。
  3. 所有改动已保存:检查暂存、未暂存、未跟踪、被忽略文件以及独有提交;子模块、嵌套仓库也要辨认,不以外层 status 干净替代。工作树有未提交修改时默认保留,不为清理自动提交、stash、reset 或丢弃。任务提交应已被目标远端集成分支包含;squash/rebase 不能仅凭祖先关系判断失败或成功,核对最终变更映射、PR 和验收,并为原任务提交保留可恢复分支/宿主快照。无法证明完整交付则保留。
  4. 非版本文件已有去向:逐项识别未跟踪及忽略文件。唯一 .env、Agent 凭据、上传文件、数据卷、报告和日志证据需移交到工程既有受控位置,验证完整性与引用后才可清理,已有文件不覆盖。仅有可再生成的依赖/缓存/产物时,确认无需保留及无运行引用后按工程已有本地文件清理授权逐项处理;未获授权的文件或用途不明项保留。符号链接只处理本链接,不递归清理链接目标;不能为了让 remove 成功执行全目录强制清空。
  5. 运行环境已恢复:按本机集成规则核对进程工作目录、服务入口、容器挂载、编辑器/终端和其他工具引用。仍被使用则保留;需要停服务时沿用工程授权,不能擅自 kill、停容器或删除数据库/持久卷。无法排除占用也是保留原因。
  6. 停止及并发门槛有效:普通单确认任务仍允许收尾且无其他执行者使用;队列在 queue-finish 后无当前单的边界,每次目录/分支清理前执行下述 cleanup guard。收到停止或守卫失败立即保留,不使用旧检查结果重试删除。

只读清点命令(把占位符替换为真实路径并正确引用,输出可能含私有文件名,只在本地检查):

git -C "$PROJECT_ROOT" worktree list --porcelain -z
git -C "$TASK_WORKTREE" status --porcelain=v1 -z --untracked-files=all
git -C "$TASK_WORKTREE" ls-files --others --ignored --exclude-standard -z
python3 "$PROJECT_ROOT/.agents/skills/personal-dev/scripts/pda.py" queue-cleanup-guard --project "$PROJECT_ROOT" --owner "$QUEUE_OWNER"

queue-cleanup-guard 只核对当前 worker 启用、owner、协议哨兵及当前单为空,不判断目录、文件、交付或进程安全;它不删除任何内容,也不在动作全过程持锁。Agent 必须完成以上检查并确认唯一执行者,破坏性动作前立即再核对路径、分支、HEAD 和文件状态;变化即保留。旧运行时无该命令则保留队列清理项,先完成升级,不能以 queue-status 或失败的 queue-guard 替代。用户已停止的队列不能为执行清理自行重启;单独的明确历史清理请求须确认旧执行者已停止,在该请求范围执行,不伪装成队列续接。

执行、恢复与分支保留

  1. 将证据、恢复路径和 removing 状态写入主目录台账。宿主原生创建的 worktree 用宿主提供的归档/清理能力,先查询真实附件 ID;比如 Codex 的 list_artifacts → archive_worktree。以当前工具能力为准;不支持、共享/固定、初始化子模块或嵌套仓库导致拒绝时保留,不能降级绕过宿主保护。宿主快照不保证保存忽略文件,文件检查仍必须执行。
  2. 自行通过 Git 创建的普通 linked worktree,通过全部检查且从目标目录外执行 git worktree remove -- "$TASK_WORKTREE",不加 --force、不使用 rm -rf 绕过拒绝。删除工具报错则保留并记录原因。清理后重新列出 worktree 并核对目录、宿主返回结果和台账,确认才记 removed/archived;不把命令发出当作成功。
  3. 操作超时或进程中断时,先查台账、Git 和宿主实际状态。目录仍存在则重新检查,不盲目重复删除;目录已消失且可证实为本次成功操作则补记结果。消失原因不明记 missing,核对挂载、宿主和恢复依据;不能仅凭目录不存在声称归档成功。
  4. worktree 移除后,本地任务分支默认至少保留至 completed_at 后 7 天;不是到期即删。到期巡检时再核对分支 tip 未变化、不被任何 worktree/任务使用、工单仍关闭、tip 被指定远端集成分支包含且不是主分支、发布/保护分支、占用/资源记录分支、永久协议哨兵或用户保留分支。符合且有既定分支清理授权才用非强制删除。git branch -d 可能只检查 upstream,不能替代指定目标分支的包含检查;squash/rebase 后不能证明包含时保留分支,另行处理恢复依据,不改用 -D。
  5. 远端任务分支默认保留,只有工程已明确授权远端分支清理策略时才执行;本地 worktree 回收不隐含远端删除。若宿主归档会改变分支/引用,也须先核对并满足相应保留策略,不能假定归档一定保留本地分支。

git worktree prune 仅清理已消失 worktree 的管理记录,不释放仍存在目录的空间。确需使用时先 dry-run,所有候选均核实为本次已完成移除的残留记录才执行;遇到外接盘未挂载、他人目录或来源不明项跳过整次 prune。参阅 Git worktree 和 Git branch。

遗留巡检与报告

默认在上述事件触发的巡检中,对已登记目录复核,而不是新增定时清理任务。已登记且仍保留的非主 worktree 超过 5 个,或任一保留项自交付完成(未完成则自创建)已超过 7 天时提醒;时间和数量只触发提醒,不是删除依据。同一批保留原因未变化时不重复通知,最近巡检和提醒摘要写入同目录 maintenance.json(同样忽略和权限检查)。可以建议处理阻塞或转移文件,不能为降低数量删除未完成任务。

最终报告分别说明“工单已完成”和“工作区已移除/已归档/保留及原因”,给出本地分支保留截止时间及恢复依据。例如:工单已关单核验,worktree 已移除,任务分支保留至具体日期;或工单已完成,但唯一配置未迁出,目录保留待清理。保持记录可追溯,不把清理失败掩盖成任务未开发或清理成功。