共计 4265 个字符,预计需要花费 11 分钟才能阅读完成。
背景
上一篇文章 保持清洁的 Git 提交记录,三招就够了,大家看过后有私下留言说这是十分好用的性能,我忽然想到工作中用到的另外一个 Git 性能那也是相当好用,必须全盘托出
作为程序员的咱们应该都有一个感触,一旦进入某个我的项目,从开发,到公布生产,到 hotfix,到前期保护,那根本都有你的份,正在开发某个 feature,老板忽然跳出来说让你做生产上的 hotfix 更是粗茶淡饭,面对这种状况,应用 Git 的咱们通常有两种解决方案:
- 草草提交未实现的 feature,而后切换分支到 hotfix
git stash | git stash pop
暂存工作内容,而后再切换到 hotfix
第二种形式较第一种还好很多,可是面对上面这些场景,stash 仍旧不是很好的解决方案
咱们面对的场景
- 正在 main 分支上跑长时间的测试,切换到 hotfix 或 feature, 测试就会中断
- 我的项目十分大,频繁的切换索引,老本十分高
- 有几年前 release 的旧版本,设置和以后不一样,IDE restructure 适配切换也会带来很大的开销
- 切换分支,须要从新设置相应的环境变量,比方 dev/qa/prod
- 须要切换到共事的代码,帮忙调试代码复现问题
有的同学想到,git clone 多个 repo 不就能够了吗?这是解决上述问题的一个办法,但背地同样暗藏很多问题:
- 多个 repo 的状态是不好同步的,比方没方法疾速 cherry-pick, 一个 repo checkout 的分支,另外一个 repo 须要从新 checkout
- git history/log 是反复的,当我的项目历史十分长,
.git
文件夹下的内容是十分占用磁盘空间的 - 同一个我的项目,多个 repo,不易治理
那如何做能力满足这些非凡场景,又不呈现这些上述这些问题呢?
git-worktree
其实,这是 Git 2015 年就开始反对的性能,却很少有人晓得它,git-worktree 的应用十分不便,在终端输出:
git worktree --help
就能够疾速看到帮忙文档阐明:
用简略的话来解释 git-worktree 的作用就是:
仅需保护一个 repo,又能够同时在多个 branch 上工作,互不影响
下面红色框线命令有很多,咱们罕用的其实只有上面这四个:
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 知识点:
- 默认状况下,
git init
或git clone
初始化的 repo,只有一个worktree
,叫做main worktree
- 在某一个目录下应用 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 文件必定是不适合的, 下一节我会介绍一个更好的方法
灵魂诘问
- 能够删除 main worktree 吗?为什么
- 重复创立和删除 worktree,repo/.git/wortree 目录的变动你能了解吗?
日拱一兵 | 原创