Git 已成为现代软件开发中不可或缺的工具,每位开发者都应当熟悉它。Git 在促进协作、维护详细历史记录、支持灵活工作流以及与现代化开发工具集成方面的能力,使其成为软件开发的必备工具。
Git 工作树 (git worktree) 是一个强大却常被忽视的功能,它让我们能够从单个 Git 仓库同时维护和管理多个工作目录。本文将深入探讨 git worktree 命令,将其与 git stash 命令进行对比,并深入了解其工作流和最佳实践。
- 什么是 git worktree?
- git worktree 功能何时引入?
- Git 工作树核心概念
- 如何使用 git worktree
- 列出已有工作树
- ➕ 添加新工作树
- ❌ 移除工作树
- 其他实用的工作树命令
- Git 工作树最佳实践
- 在 IDE 中支持 git worktree
- 结语
一、什么是 git worktree?
Git 工作树 (git worktree) 是一项 Git 功能,使我们能够拥有与单个 Git 仓库关联的多个工作目录 (worktree)。这让我们可以同时检出 (checkout) 和处理仓库的多个分支,而无需多次克隆仓库或暂存 (stash) 我们的更改。
传统上,在 Git 中切换分支需要我们提交或暂存更改,这在同时处理多个任务时可能会很麻烦。使用 git worktree,我们可以:
- 在独立的目录中同时处理多个分支。
- 避免多次克隆仓库的开销。
- 为不同任务维护隔离的环境,例如功能开发、错误修复或代码审查。
二、git worktree 功能何时引入?
git worktree 功能首次引入于 2015 年 7 月发布的 Git 2.5 版本。随后,在 Git 2.7.0 (2015年10月) 中,git worktree 命令获得了重大增强。
三、Git 工作树核心概念
Git 工作树使我们能够从单个仓库拥有多个工作空间,这意味着我们可以同时从同一仓库将多个分支检出到单独的目录中。每个工作树都有自己的工作目录、HEAD 和索引,这意味着一个工作树中的更改不会立即影响其他工作树。
这与传统工作流形成对比,在传统工作流中,切换分支需要暂存或提交未完成的工作。
一个 Git 仓库通常有一个"主工作树" (原始克隆) 和与之关联的"零个或多个链接工作树"。
四、如何使用 git worktree
显然,第一个要求是安装 Git 2.5 或更高版本。您可以使用以下命令检查 Git 版本:git version。
列出已有工作树
我通常首先检查的是查看与仓库关联的所有工作树:
git worktree list
由于某些原因,我必须切换到 main 分支,因为我在 gemini-cli-impl 分支中有未提交的更改。我必须暂存更改,但我们不想使用暂存,而是想使用工作树。
➕ 添加新工作树
要为现有分支创建新工作树,我们需要提供路径和分支名称 (或提交):
git worktree add <path> <branch_or_commit>
路径是相对的,可以位于当前文件夹内部或外部。我通常在项目根文件夹中创建一个 .worktree 文件夹,并将该文件夹添加到 .gitignore 文件中,然后在此文件夹内创建工作树。
git worktree add ./.worktree/bugfix1 main
此命令将在 .worktree 文件夹内创建一个名为 bugfix1 的文件夹,并在其中检出 main 分支:
如果我们不指定分支,git 会为我们创建一个以路径命名的分支。如果分支不存在,Git 不会为我们创建它。我们也可以用 -b 参数指定新分支名称:
❌ 移除工作树
我们不能从一个分支创建多个工作树:
当不再需要工作树时,我们可以使用 remove 命令将其移除。首先,运行 list 命令查看现有工作树列表:
现在我们可以通过指定路径来移除工作树:
git worktree remove bugfix1
如果指定的工作树包含已修改或未跟踪的文件,除非我们使用 --force 标志删除,否则无法移除它。
其他实用的工作树命令
git worktree prune:清理与目录已不存在的工作树关联的过时管理文件。这最终会通过 gc.worktreePruneExpire 自动完成,但也可以手动运行。
git worktree lock [ — reason <string>] <worktree>:防止工作树的管理文件被清理,对于位于可移动或未挂载设备上的工作树很有用。
git worktree unlock <worktree>:解除锁定,允许清理、移动或删除。
git worktree move <worktree> <new-path>:将链接工作树移动到新位置。
git worktree repair [<path>…]:如果路径被手动移动或损坏,重新建立主仓库与链接工作树之间的连接。