git worktree与分支依赖隔离

git worktree介绍

git worktree 是 Git 命令,用于管理多分支工作区。

使用场景

  • 同时维护不同分支,隔离分支依赖差异:从原有项目开辟一个分支作为另一个新项目,当两个项目依赖差距越来越大时,每次切换分支后都需要重新安装依赖。通过git worktree 可以隔离两个分支的依赖,并且两个分支可以互相merge、cherry-pick。
  • 多个分支同步开发:允许在同一存储库中的不同分支上同时进行工作,而不需要频繁切换分支,这对于需要同时处理多个功能或修复多个 bug 的情况非常有用。
  • 进行实验性更改:在不影响主工作目录的情况下,尝试进行实验性的更改或调试。
  • 同时进行长期和短期任务:有助于同时处理长期开发任务和短期修复任务,而无需相互影响或混淆。

以下是 git worktree 的子命令:

  • add:在当前分支下创建一个新工作区。
  • remove:删除一个已添加的工作区。
  • list:显示所有已添加的工作区。
  • lock:锁定工作区以防止在合并或其他操作时被意外删除。
  • unlock:手动取消工作区的锁定。

git worktree add <path> [(-b | -B) <new-branch>]

在当前分支下创建一个新工作区,效果类似于git clone ,但新旧工作区属于同一个仓库,可以正常add、commit、merge等操作。

  • <path>:要创建的新工作区的路径,一般建立在当前目录的上一层,如../newpath
  • <new-branch>:要在哪个分支上创建工作区。如果未指定<new-branch>,则表示基于当前分支HEAD创建新分支<path>-b表示基于当前分支HEAD创建新分支<new-branch>-B表示强制创建。
# 基于HEAD创建工作区../brance1,分支为brance1
# 相当于 git worktree add ../brance1 -b brance1
git worktree add ../brance1
# 关联branch2创建工作区../brance1,分支为brance2
git worktree add ../brance1 branch2
# 基于HEAD创建工作区../brance1,分支为brance2
git worktree add ../brance1 -b brance2

git worktree remove <worktree>

移除worktree有两种方式。

  • 方式一:
# 移除指定工作区<worktree>
git worktree remove <worktree>
  • 方式二:直接删除工作区对应的文件夹,然后执行
# 清除worktree记录
git worktree prune

git worktree list

显示所有已添加的工作区。

git worktree list

# 显示完整的hash值
git worktree list --porcelain

git worktree lock <worktree>

用于锁定工作区<worktree>,以防止在合并或其他操作时被意外删除。

git worktree unlock <worktree>

解锁工作区<worktree>

git worktree处理分支依赖冲突

背景

现在远程仓库有一个项目gitworktree,存在两个分支vuereact,两个分支作为两个项目并行开发,且两分支下的依赖存在差异。

步骤

1、 将gitworktree目录下所有内容迁移到新的文件夹gitworktree/project1,方便在一个文件夹下管理。

2、 在目录gitworktree/project1下,执行git worktree add ../vue vue。执行完后可以发现gitworktree目录下存在两个文件夹,分别是project1 和 vue。

3、 在目录gitworktree/project1下,执行git worktree add ../react react。执行完后可以发现gitworktree目录下存在三个文件夹,分别是project1 、 vue 和 react。

这时候就可以愉快的玩耍了,可以像往常一样add、commit、merge,甚至cherry-pick!两个分支vuereact已经隔离开了,且依赖互不影响。

与往常不同的是,vuereact之间不能互相切换分支,只需要打开对应工作区即可进入对应的分支。