不切换 Git 分支,却能同时在多个分支上工做,我是怎么作到的?

2021年11月25日 阅读数:20
这篇文章主要向大家介绍不切换 Git 分支,却能同时在多个分支上工做,我是怎么作到的?,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。

背景

上一篇文章 保持清洁的Git提交记录,三招就够了 ,你们看事后有私下留言说这是很是好用的功能,我忽然想到工做中用到的另一个 Git 功能那也是至关好用,必须全盘托出git

做为程序员的咱们应该都有一个感觉,一旦进入某个项目,从开发,到发布生产,到 hotfix,到后期维护,那基本都有你的份,正在开发某个 feature,老板忽然跳出来讲让你作生产上的 hotfix 更是屡见不鲜,面对这种状况,使用 Git 的咱们一般有两种解决方案:程序员

  1. 草草提交未完成的 feature,而后切换分支到 hotfix
  2. git stash | git stash pop 暂存工做内容,而后再切换到 hotfix

第二种方式较第一种还好不少,但是面对下面这些场景,stash 依旧不是很好的解决方案shell

咱们面对的场景

  1. 正在 main 分支上跑长时间的测试,切换到 hotfix 或 feature, 测试就会中断
  2. 项目很是大,频繁的切换索引,成本很是高
  3. 有几年前 release 的旧版本,设置和当前不同,IDE restructure 适配切换也会带来很大的开销
  4. 切换分支,须要从新设置相应的环境变量,好比 dev/qa/prod
  5. 须要切换到同事的代码,帮助调试代码复现问题

有的同窗想到,git clone 多个 repo 不就能够了吗?这是解决上述问题的一个方法,但背后一样隐藏不少问题:segmentfault

  1. 多个 repo 的状态是很差同步的,好比没办法快速 cherry-pick, 一个 repo checkout 的分支,另一个 repo 须要从新 checkout
  2. git history/log 是重复的,当项目历史很是长,.git 文件夹下的内容是很是占用磁盘空间的
  3. 同一个项目,多个 repo,不易管理

那如何作才能知足这些特殊场景,又不出现这些上述这些问题呢?测试

git-worktree

其实,这是 Git 2015 年就开始支持的功能,却不多有人知道它,git-worktree 的使用很是方便,在终端输入:spa

git worktree --help

就能够快速看到帮助文档说明:3d

用简单的话来解释 git-worktree 的做用就是:调试

仅需维护一个 repo,又能够同时在多个 branch 上工做,互不影响

上面红色框线命令有不少,咱们经常使用的其实只有下面这四个:rest

 git worktree add [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
 git worktree list [--porcelain]
 git worktree remove [-f] <worktree>
 git worktree prune [-n] [-v] [--expire <expire>]

在展开说明以前,须要和你们普及两个你可能忽视的 Git 知识点:code

  1. 默认状况下, git initgit clone 初始化的 repo,只有一个 worktree,叫作 main worktree
  2. 在某一个目录下使用 Git 命令,当前目录下要么有 .git 文件夹;要么有 .git 文件,若是只有 .git 文件,里面的内容必须是指向 .git 文件夹的

第二句话感受挺绕的,下面用例子说明,就很容易明白了

git worktree add

当前项目目录结构是这样的(amend-crash-demo 是 repo 的 root):

.
└── amend-crash-demo

1 directory

cd amend-crash-demo 运行命令 git worktree add ../feature/feature2

➜  amend-crash-demo git:(main) git worktree add ../feature/feature2
Preparing worktree (new branch 'feature2')
HEAD is now at 82b8711 add main file

从新看目录结构

.
├── amend-crash-demo
└── feature
    └── feature2

3 directories

该命令默认会根据 HEAD 所在的 commit-ish (固然也能够指定 git log 中的任意一个 commit-ish) 建立一个名为 feature2 的分支,分支磁盘位置如上面结构所示

cd ../feature/feature2/ 会发现,这个分支下并不存在 .git 文件夹,却存在一个 .git 文件,打开文件,内容以下:

gitdir: /Users/rgyb/Documents/projects/amend-crash-demo/.git/worktrees/feature2

到这里,你再理解一下上面的知识点2,是否是就清晰许多了呢?

接下来,你就能够在 feature2 分支上作一切你想作的内容了(add/commit/pull/push),和 main worktree 互不干扰

通常状况下,项目组都有必定的分支命名规范,好比 feature/JIRAID-Title, hotfix/JIRAID-Title, 若是仅仅按照上面命令新建 worktree,分支名称中的 / 会被当成文件目录来处理

git worktree add ../hotfix/hotfix/JIRA234-fix-naming

运行完该命令,文件目录结构是这样的

.
├── amend-crash-demo
├── feature
│   └── feature2
└── hotfix
    └── hotfix
        └── JIRA234-fix-naming

6 directories

很显然这不是咱们想要的,这时咱们就须要 -b 参数的支持了,就像 git checkout -b 同样

执行命令:

git worktree add -b "hotfix/JIRA234-fix-naming" ../hotfix/JIRA234-fix-naming

再来看一下目录结构

.
├── amend-crash-demo
├── feature
│   └── feature2
└── hotfix
    ├── JIRA234-fix-naming
    └── hotfix
        └── JIRA234-fix-naming

7 directories

进入 JIRA234-fix-naming 目录,默认是在 hotfix/JIRA234-fix-naming 分支上

worktree 创建起来很容易,不加管理,项目目录结构确定乱糟糟,这是咱们不想看到的,因此咱们须要清晰的知道某个 repo 都创建了哪些 worktree

git worktree list

全部的worktree 都在共用一个 repo,因此在任意一个 worktree 目录下,均可以执行以下命令来查看 worktree 列表

git worktree list

执行完命令后,能够查看到咱们上面建立的全部 worktree 信息, main worktree 也会显示在此处

/Users/rgyb/Documents/projects/amend-crash-demo                        82b8711 [main]
/Users/rgyb/Documents/projects/chore/chore                                   8782898 (detached HEAD)
/Users/rgyb/Documents/projects/feature/feature2                             82b8711 [feature2]
/Users/rgyb/Documents/projects/hotfix/hotfix/JIRA234-fix-naming     82b8711 [JIRA234-fix-naming]
/Users/rgyb/Documents/projects/hotfix/JIRA234-fix-naming              82b8711 [hotfix/JIRA234-fix-naming]

worktree 的工做作完了,也是要及时删除的,不然也会浪费不少磁盘空间

git worktree remove

这个命令很简单了,worktree 的名字叫什么,直接就 remove 什么就行了

git worktree remove hotfix/hotfix/JIRA234-fix-naming

此时,分支名弄错的那个 hotfix 就被删掉了

/Users/rgyb/Documents/projects/amend-crash-demo                        82b8711 [main]
/Users/rgyb/Documents/projects/chore/chore                                   8782898 (detached HEAD)
/Users/rgyb/Documents/projects/feature/feature2                             82b8711 [feature2]
/Users/rgyb/Documents/projects/hotfix/JIRA234-fix-naming              82b8711 [hotfix/JIRA234-fix-naming]

假设你建立一个 worktree,并在里面有改动,忽然间这个worktree 又不须要了,此刻你按照上述命令是不能删掉了,此时就须要 -f 参数来帮忙了

git worktree remove -f hotfix/JIRA234-fix-naming

删除了 worktree,其实在 Git 的文件中,还有不少 administrative 文件是没有用的,为了保持清洁,咱们还须要进一步清理

git worktree prune

这个命令就是清洁的兜底操做,可让咱们的工做始终保持整洁

总结

到这里,你应该理解,整个 git-worktree 的使用流程就是下面这四个命令:

git worktree add
git worktree list
git worktree remove
git worktree prune

你也应该明白 git worktree 和 git clone 多个 repo 的区别了。只维护一个 repo,建立多个 worktree,操做间行云流水

个人实践:一般使用 git worktree,我会统一目录结构,好比 feature 目录下存放全部 feature 的worktree,hotfix 目录下存放全部 hotfix 的 worktree,这样整个磁盘目录结构不至于由于建立多个 worktree 而变得混乱

在磁盘管理上我有些强迫症,理想状况下,某个 repo 的 worktree 最好放在这个 repo 的文件目录里面,但这就会致使 Git track 新建立的 worktree 下的全部文件,为了不 Git track worktree 的内容,来来回回修改 gitignore 文件确定是不合适的,下一节我会介绍一个更好的办法

灵魂追问

  1. 能够删除 main worktree 吗?为何
  2. 反复建立和删除worktree, repo/.git/wortree 目录的变化你能理解吗?

日拱一兵 | 原创