feat(git): 完善 Worktree 生命周期与发布约定
This commit is contained in:
zhiye.sun
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "git",
|
||||
"version": "0.4.0",
|
||||
"version": "0.5.0",
|
||||
"description": "安全、可复核的通用 Git 工作流。",
|
||||
"author": {
|
||||
"name": "CraftKit"
|
||||
|
||||
@@ -1,18 +1,25 @@
|
||||
---
|
||||
name: branch
|
||||
description: 根据当前仓库约定生成名称，并在用户确认准确命令后创建和切换本地 Git 分支。适用于明确要求新建分支的场景；仅查看、重命名、删除、合并、推送或发布分支不应触发本 Skill。
|
||||
description: 根据当前仓库约定，在用户确认后于当前工作区或独立 worktree 创建本地 Git 分支，并在分支任务结束后安全关闭额外 worktree。适用于新增需求、缺陷、维护分支及解除 worktree 分支占用；仅查看、重命名、删除、合并、推送或发布分支不应触发本 Skill。
|
||||
---
|
||||
|
||||
# 创建 Git 分支
|
||||
|
||||
安全地创建并切换本地分支。所有检查默认只读；`fetch` 和分支创建分别需要明确授权，不得把它们合并为一次隐含操作。
|
||||
安全地创建本地分支并管理其独立 worktree 生命周期。所有检查默认只读；`fetch`、分支创建和 worktree 移除分别需要明确授权，不得把它们合并为一次隐含操作。
|
||||
|
||||
## 选择模式
|
||||
|
||||
- `create`：规划名称，并在当前工作区或独立 worktree 创建分支。
|
||||
- `close`：分支任务结束后安全移除额外 worktree，释放分支占用。
|
||||
|
||||
涉及独立 worktree 时读取 [Worktree 分支规则](references/worktree-branch.md)。用户只说“创建分支”时进入 `create`；用户要求结束、关闭、清理额外 worktree，或出现分支已被 worktree 占用错误时进入 `close`。
|
||||
|
||||
## 创建前检查
|
||||
|
||||
1. 运行 `git status --short --branch`、`git branch --show-current`、`git branch --list`、`git branch --remotes` 和 `git worktree list --porcelain`。
|
||||
2. 读取当前仓库适用的 `AGENTS.md`、贡献指南或其他明确的分支约定；没有约定时再参考现有分支命名。
|
||||
3. 收集分支用途、简短描述和基准引用。不要默认 `main`、`master`、远程名称、版本分支或合并目标。
|
||||
4. 若工作区不干净，说明现有修改会随切换保留；在用户明确选择继续前不得创建分支，也不得自动暂存、提交、还原或清理。
|
||||
4. 若工作区不干净，列出现有修改并说明直接切换会携带这些修改；不得自动暂存、提交、还原或清理，优先建议使用独立 worktree。
|
||||
5. `.craftkit/local/**` 和 `.craftkit/cache/**` 不视为业务改动；若它们出现在普通状态中，提示检查 `.craftkit/.gitignore`。`.craftkit/agents/**`、`standards/**`、`knowledge/**`、`handoff/**` 和 `project.json` 属于普通项目改动，应与其他未提交内容一起展示。
|
||||
|
||||
## 生成和验证名称
|
||||
@@ -34,9 +41,11 @@ description: 根据当前仓库约定生成名称，并在用户确认准确命
|
||||
- 当前分支和工作区状态；
|
||||
- 目标分支名称；
|
||||
- 基准引用及其提交短哈希；
|
||||
- 是否会携带未提交修改；
|
||||
- 在当前工作区还是独立 worktree 创建，以及是否影响未提交修改；
|
||||
- 将执行的唯一创建命令。
|
||||
|
||||
工作区干净、当前 checkout 可以切换且用户没有隔离要求时，可以在当前工作区创建。工作区不干净、当前分支被 IDE/服务/测试占用，或用户要求不影响当前 checkout 时，使用独立 worktree；创建前确认目标绝对路径不存在、分支不存在且基准哈希已锁定。
|
||||
|
||||
本地基准使用：
|
||||
|
||||
```text
|
||||
@@ -49,10 +58,16 @@ git switch -c "<branch>" "<base>"
|
||||
git switch --no-track -c "<branch>" "<remote>/<base>"
|
||||
```
|
||||
|
||||
独立 worktree 使用：
|
||||
|
||||
```text
|
||||
git worktree add -b "<branch>" "<absolute-worktree-path>" "<base>"
|
||||
```
|
||||
|
||||
只有用户在看到上述最终信息后明确确认，才执行该命令。用户调整名称或基准后必须重新展示并确认。
|
||||
|
||||
## 创建后验证
|
||||
|
||||
运行 `git branch --show-current`、`git rev-parse --short HEAD` 和 `git status --short --branch`，确认当前分支、起点和工作区状态。远程基准创建时再用 `git rev-parse --abbrev-ref --symbolic-full-name @{upstream}` 检查没有错误 upstream；命令返回“无 upstream”属于预期结果。
|
||||
在实际创建位置运行 `git branch --show-current`、`git rev-parse --short HEAD` 和 `git status --short --branch`，确认当前分支、起点和工作区状态。独立 worktree 创建后还要复核主工作区分支、HEAD 和未提交内容未变化，并明确报告分支占用路径、后续操作目录以及生命周期结束后的清理义务。远程基准创建时再用 `git rev-parse --abbrev-ref --symbolic-full-name @{upstream}` 检查没有错误 upstream；命令返回“无 upstream”属于预期结果。
|
||||
|
||||
本 Skill 到此结束，不执行 push、不设置远程 upstream，也不创建合并请求。失败时报告原始错误和当前仓库状态，不自动重试破坏性替代命令。
|
||||
`create` 到此不执行 push、不设置远程 upstream，也不创建合并请求。独立 worktree 在分支任务完成前保持 `active`，完成后必须调用 `close` 进入清理门禁。失败时报告原始错误和当前仓库状态，不自动重试破坏性替代命令。
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
interface:
|
||||
display_name: "Create Branch"
|
||||
short_description: "确认名称和基准后安全创建本地 Git 分支"
|
||||
default_prompt: "使用 $branch 为当前仓库规划并创建一个本地分支，执行前先向我确认。"
|
||||
short_description: "创建分支并管理独立 Worktree 的安全关闭"
|
||||
default_prompt: "使用 $branch 规划并创建本地分支；工作区不干净时使用独立 worktree，分支任务结束后安全关闭它，所有写操作前先向我确认。"
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
# Worktree 分支规则
|
||||
|
||||
## 创建条件
|
||||
|
||||
满足任一条件时，优先在独立 worktree 创建新需求、缺陷或维护分支，不切换当前主工作区：
|
||||
|
||||
- 主工作区存在未提交文件、本地配置、环境配置或缓存；
|
||||
- 用户要求不影响当前 checkout；
|
||||
- 当前分支正被 IDE、服务或测试占用；
|
||||
- 当前工作需要与主工作区并行进行。
|
||||
|
||||
Worktree 共享仓库对象和本地分支引用。同一个本地分支不能同时被两个 worktree 签出。
|
||||
|
||||
## 创建前检查
|
||||
|
||||
确认主仓库绝对路径、目标 worktree 绝对路径、分支名、基准引用和完整哈希。检查目标路径不存在、同名本地及远程引用的处理已经确认、目标分支未被其他 worktree 占用。分支名可能包含中文时始终加引号。
|
||||
|
||||
取得分支创建授权后执行唯一命令：
|
||||
|
||||
```text
|
||||
git worktree add -b "<branch>" "<absolute-worktree-path>" "<base>"
|
||||
```
|
||||
|
||||
创建后验证新 worktree 的分支、HEAD 和状态，并重新检查主工作区分支、HEAD 和未提交内容未变化。报告该分支的占用路径，提示主工作区不能同时签出，并记录任务完成后的清理义务。
|
||||
|
||||
## 关闭条件
|
||||
|
||||
创建分支的当次操作完成不等于 worktree 生命周期结束。只有分支开发任务、验证和用户要求的交付已经完成，并且用户不再要求保留现场时，才进入 `close`。
|
||||
|
||||
关闭前必须满足：
|
||||
|
||||
- worktree 没有未提交或未跟踪文件；
|
||||
- 没有进行中的 merge、rebase、cherry-pick 或 revert；
|
||||
- 当前 HEAD 已被预期本地分支引用；
|
||||
- 主仓库、worktree 路径、分支和 HEAD 均已准确确认。
|
||||
|
||||
展示检查结果、移除后保留的分支和唯一清理命令，取得用户确认后执行：
|
||||
|
||||
```text
|
||||
git -C "<main-repository>" worktree remove "<absolute-worktree-path>"
|
||||
```
|
||||
|
||||
不得直接删除目录，不得默认使用 `--force`，不得删除或重置分支，也不得批量清理其他 worktree。
|
||||
|
||||
## 关闭后验证
|
||||
|
||||
```text
|
||||
Test-Path -LiteralPath "<absolute-worktree-path>"
|
||||
git -C "<main-repository>" rev-parse --verify "<branch>"
|
||||
git -C "<main-repository>" worktree list --porcelain
|
||||
git -C "<main-repository>" status --short --branch
|
||||
```
|
||||
|
||||
目录不存在、占用记录已释放、分支和提交仍存在、主工作区原有状态未变化时，关闭才算完成。
|
||||
|
||||
## 分支占用错误
|
||||
|
||||
```text
|
||||
fatal: '<branch>' is already used by worktree at '<path>'
|
||||
```
|
||||
|
||||
该错误表示分支仍由指定 worktree 签出。若任务仍在进行，继续在该 worktree 中操作；若任务已经结束，执行 `close`。不得强制 checkout、直接删除目录或删除分支绕过占用保护。
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: integrate
|
||||
description: 评估两个 Git 分支的集成风险，并在用户逐步确认后通过隔离 worktree 准备、验证和发布预集成分支。适用于合并前验证或准备 MR/PR；直接修改目标分支、一键推送或未经审查处理冲突不应触发本 Skill。
|
||||
description: 评估两个 Git 分支的集成风险，并在用户逐步确认后通过隔离 worktree 准备、验证、发布和清理预集成分支。适用于合并前验证、准备 MR/PR 或关闭预集成 worktree；直接修改目标分支、一键推送或未经审查处理冲突不应触发本 Skill。
|
||||
---
|
||||
|
||||
# Git 分支集成
|
||||
@@ -12,6 +12,7 @@ description: 评估两个 Git 分支的集成风险，并在用户逐步确认
|
||||
- `assess`：只读比较分支、预判冲突和识别交付风险。执行时读取 [评估规则](references/assess.md)。
|
||||
- `prepare`：在独立 worktree 中创建预集成分支、执行 merge 并验证。执行时读取 [准备规则](references/prepare.md)。
|
||||
- `publish`：推送预集成分支并准备 MR/PR。执行时读取 [发布规则](references/publish.md)。
|
||||
- `cleanup`：本地交付或发布完成后关闭独立 worktree。执行时读取 [Worktree 生命周期](references/worktree-lifecycle.md)。
|
||||
|
||||
用户要求“集成”但未明确阶段时，从 `assess` 开始。前一阶段的授权不能自动扩展到后一阶段。
|
||||
|
||||
@@ -22,7 +23,9 @@ description: 评估两个 Git 分支的集成风险，并在用户逐步确认
|
||||
- fetch、worktree 创建、分支创建、merge、冲突暂存、commit、push 和创建 MR/PR 分别展示准确命令并取得对应确认。
|
||||
- 工作区不干净、引用不可解析、已有 worktree 冲突或分支归属不清时停止写操作。
|
||||
- 不自动使用 `ours`、`theirs`、rebase、reset、stash、强制推送或历史改写。
|
||||
- 不直接把预集成分支合入目标分支，也不自动删除 worktree 或分支。
|
||||
- 不直接把预集成分支合入目标分支，也不删除预集成分支。
|
||||
- Worktree 生命周期结束后必须进入 `cleanup` 门禁；未确认准确路径、状态、HEAD 和分支引用前不得移除，也不得使用 `--force`。
|
||||
- 预集成是否合格以目标分支到预集成分支的真实差异为准，不能只凭 merge 输出、分支名、提交数量或测试通过判断。
|
||||
|
||||
## 环境和本地配置
|
||||
|
||||
@@ -36,6 +39,7 @@ description: 评估两个 Git 分支的集成风险，并在用户逐步确认
|
||||
|
||||
- 只读集成评估报告；
|
||||
- 本地隔离且已验证的预集成分支；
|
||||
- 经独立授权推送的预集成分支及 MR/PR 建议。
|
||||
- 经独立授权推送的预集成分支及 MR/PR 建议；
|
||||
- 生命周期已经结束并安全移除额外 worktree，同时保留预集成分支和提交。
|
||||
|
||||
报告源、目标、预集成分支和对应哈希，列出冲突处理、验证结果、环境配置判断及仍需人工完成的动作。
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
interface:
|
||||
display_name: "Integrate Branches"
|
||||
short_description: "隔离评估、准备并发布可审查的预集成分支"
|
||||
default_prompt: "使用 $integrate 先只读评估这两个分支的集成风险，再决定是否准备预集成分支。"
|
||||
short_description: "隔离准备、发布并安全清理预集成 Worktree"
|
||||
default_prompt: "使用 $integrate 先只读评估分支集成风险，再准备和验证预集成分支；生命周期结束后安全移除额外 worktree。"
|
||||
|
||||
@@ -7,6 +7,8 @@
|
||||
- 当前工作区和目标 worktree 路径没有未处理状态或归属冲突。
|
||||
- 环境配置风险已按项目规范处理；凭据风险为零。
|
||||
|
||||
创建、复用或关闭独立 worktree 时，同时读取 [Worktree 生命周期](worktree-lifecycle.md)。
|
||||
|
||||
## 隔离创建
|
||||
|
||||
根据项目规范决定预集成分支基于源还是目标。没有规范时说明两种历史形状，由用户选择，不能默认套用固定组织模型。
|
||||
@@ -32,4 +34,6 @@ git status --short --branch
|
||||
|
||||
确认源、目标引用仍等于操作前哈希；只有预集成分支发生变化。记录 merge 提交、测试结果和未验证边界。
|
||||
|
||||
保留 worktree 供用户复核。清理 worktree、删除分支或中止 merge 都是独立操作，不属于自动收尾。
|
||||
必须以目标引用为基准检查 `git diff --check "<target>...HEAD"`、`git diff --stat "<target>...HEAD"`、`git diff --name-status "<target>...HEAD"` 和 `git log --oneline "<target>..HEAD"`。最终文件清单包含本地配置、缓存、IDE 文件或无关需求文件时停止，不得进入交付阶段。
|
||||
|
||||
需要人工复核时暂时保留 worktree 并标记为 `delivery-ready`。用户确认仅本地交付，或完成已授权的发布后，生命周期进入 `cleanup-ready`，必须继续执行清理门禁。中止 merge 和删除分支不属于自动收尾。
|
||||
|
||||
@@ -23,3 +23,7 @@
|
||||
- 关联任务或项目文档。
|
||||
|
||||
默认只给出标题、描述、命令或网页入口。实际创建 MR/PR 需要新的明确授权；审核、合并、删除远程分支和删除 worktree 均不在本阶段自动执行。
|
||||
|
||||
## 发布后收尾
|
||||
|
||||
完成用户已授权的推送或 MR/PR 创建后，确认远程结果和本地预集成分支仍可解析，然后将 worktree 标记为 `cleanup-ready`，继续读取 [Worktree 生命周期](worktree-lifecycle.md) 并执行清理门禁。移除额外 worktree 不删除本地或远程分支。
|
||||
|
||||
@@ -0,0 +1,103 @@
|
||||
# Worktree 生命周期
|
||||
|
||||
## 适用范围
|
||||
|
||||
本规则管理预集成独立 worktree 从创建到安全移除的完整生命周期。主工作区不干净、用户要求不影响当前 checkout、当前分支被 IDE/服务/测试占用、需要复用旧预集成分支或预计发生冲突时，必须使用独立 worktree。
|
||||
|
||||
Worktree 只隔离工作目录；所有 worktree 共享仓库对象和本地分支引用。同一个本地分支不能同时被两个 worktree 签出。
|
||||
|
||||
## 生命周期状态
|
||||
|
||||
- `planned`：已确认仓库、分支、基准和绝对路径，尚未创建。
|
||||
- `active`：worktree 已创建，开发、合并或验证正在进行。
|
||||
- `delivery-ready`：差异和验证完成，等待本地交付确认或发布。
|
||||
- `cleanup-ready`：本地交付已确认，或用户要求的发布已经完成，可以清理。
|
||||
- `cleanup-blocked`：存在未提交内容、进行中的 Git 操作、引用风险或需要保留的现场。
|
||||
- `removed`：额外 worktree 已移除，分支和提交仍存在。
|
||||
|
||||
## 创建和占用记录
|
||||
|
||||
创建前确认目标绝对路径不存在、目标分支未被其他 worktree 占用、基准引用可解析并记录完整哈希。分支名可能包含中文时始终加引号，不使用 `$HOME`、`$home` 或 `$CODEX_HOME` 作为任务变量。
|
||||
|
||||
创建后记录并报告：
|
||||
|
||||
- 主仓库绝对路径；
|
||||
- worktree 绝对路径；
|
||||
- worktree 当前分支和 HEAD；
|
||||
- 主工作区当前分支、HEAD 和未提交状态；
|
||||
- 该分支已被额外 worktree 占用，主工作区不能同时签出；
|
||||
- 后续操作目录和生命周期结束后的清理义务。
|
||||
|
||||
## 新建或复用预集成
|
||||
|
||||
旧预集成已经合入目标分支时，默认新建增量预集成分支，使交付历史易于审计。只有用户明确选择复用，并且旧预集成可解析、上次源分支基线已包含、旧预集成与目标分支关系已查清、最终 `<target>...HEAD` 可收敛为本次需求文件时，才能继续复用。
|
||||
|
||||
历史中存在直接合入错误版本分支、无关需求或异常大量文件时，不得只因引用可解析就复用。复用时推荐先合入源分支最新增量，再合入最新目标分支；项目规范规定其他拓扑时以项目规范为准。
|
||||
|
||||
## 交付范围和结束条件
|
||||
|
||||
Merge 输出出现大量目标分支文件不等于 MR/PR 包含这些文件。必须检查：
|
||||
|
||||
```text
|
||||
git diff --check "<target>...HEAD"
|
||||
git diff --stat "<target>...HEAD"
|
||||
git diff --name-status "<target>...HEAD"
|
||||
git log --oneline "<target>..HEAD"
|
||||
git log --first-parent --oneline -20
|
||||
```
|
||||
|
||||
只有同时满足以下条件，生命周期才可进入 `cleanup-ready`：
|
||||
|
||||
- 本次开发或预集成已经完成；
|
||||
- 用户要求的验证已经完成；
|
||||
- 用户确认仅本地交付，或用户要求的发布已经完成；
|
||||
- worktree 没有未提交或未跟踪文件；
|
||||
- 没有进行中的 merge、rebase、cherry-pick 或 revert；
|
||||
- 当前 HEAD 已被预期本地分支引用；
|
||||
- 用户不再要求保留现场。
|
||||
|
||||
用户要求保留现场时标记为 `delivery-ready`，明确说明生命周期尚未结束以及分支仍被该 worktree 占用。
|
||||
|
||||
## 清理门禁
|
||||
|
||||
移除前展示主仓库和 worktree 的准确绝对路径、分支、HEAD、状态、分支引用验证和唯一清理命令。检查至少包括：
|
||||
|
||||
```text
|
||||
git -C "<worktree>" status --porcelain
|
||||
git -C "<worktree>" branch --show-current
|
||||
git -C "<worktree>" rev-parse HEAD
|
||||
git -C "<worktree>" rev-parse -q --verify MERGE_HEAD
|
||||
git -C "<main-repository>" worktree list --porcelain
|
||||
git -C "<main-repository>" branch --contains "<head-sha>"
|
||||
```
|
||||
|
||||
`MERGE_HEAD` 不存在是预期结果。还要依据 Git 状态确认不存在 rebase、cherry-pick 或 revert；任一操作未结束时标记为 `cleanup-blocked`。
|
||||
|
||||
用户确认准确清理信息后执行：
|
||||
|
||||
```text
|
||||
git -C "<main-repository>" worktree remove "<absolute-worktree-path>"
|
||||
```
|
||||
|
||||
不得直接删除目录，不得默认使用 `--force`，不得为解除占用而删除或重置分支，也不得批量清理其他 worktree。
|
||||
|
||||
## 清理后验证
|
||||
|
||||
```text
|
||||
Test-Path -LiteralPath "<absolute-worktree-path>"
|
||||
git -C "<main-repository>" rev-parse --verify "<branch>"
|
||||
git -C "<main-repository>" worktree list --porcelain
|
||||
git -C "<main-repository>" status --short --branch
|
||||
```
|
||||
|
||||
只有目录不存在、worktree 列表已释放占用、分支和提交仍存在、主工作区原有状态未变化时，才能标记为 `removed`。
|
||||
|
||||
## 分支已被占用
|
||||
|
||||
出现以下错误表示目标分支仍由额外 worktree 签出：
|
||||
|
||||
```text
|
||||
fatal: '<branch>' is already used by worktree at '<path>'
|
||||
```
|
||||
|
||||
继续在错误给出的 worktree 中操作，或者在其生命周期结束并通过清理门禁后移除。不得强制 checkout、直接删除目录或删除分支绕过 Git 的占用保护。
|
||||
Reference in New Issue
Block a user