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

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

背景


上一篇文章 保持清洁的Git提交记录,三招就够了 ,大家看过后有私下留言说这是非常好用的功能,我突然想到工作中用到的另外一个 Git 功能那也是相当好用,必须全盘托出

作为程序员的我们应该都有一个感受,一旦进入某个项目,从开发,到发布生产,到 hotfix,到后期维护,那基本都有你的份,正在开发某个 feature,老板突然跳出来说让你做生产上的 hotfix 更是家常便饭,面对这种情况,使用 Git 的我们通常有两种解决方案:


  1. 草草提交未完成的 feature,然后切换分支到 hotfix


  1. git stash | git stash pop 暂存工作内容,然后再切换到 hotfix


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


微信图片_20220512121302.png


我们面对的场景


  1. 正在 main 分支上跑长时间的测试,切换到 hotfix 或 feature, 测试就会中断


  1. 项目非常大,频繁的切换索引,成本非常高


  1. 有几年前 release 的旧版本,设置和当前不一样,IDE restructure 适配切换也会带来很大的开销


  1. 切换分支,需要重新设置相应的环境变量,比如 dev/qa/prod


  1. 需要切换到同事的代码,帮助调试代码复现问题


有的同学想到,git clone 多个 repo 不就可以了吗?这是解决上述问题的一个方法,但背后同样隐藏很多问题:


  1. 多个 repo 的状态是不好同步的,比如没办法快速 cherry-pick, 一个 repo checkout 的分支,另外一个 repo 需要重新 checkout


  1. git history/log 是重复的,当项目历史非常长,.git 文件夹下的内容是非常占用磁盘空间的


  1. 同一个项目,多个 repo,不易管理


那如何做才能满足这些特殊场景,又不出现这些上述这些问题呢?


git-worktree


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


git worktree --help


就可以快速看到帮助文档说明:


微信图片_20220512121422.png


用简单的话来解释 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 知识点:


  1. 默认情况下, git initgit clone 初始化的 repo,只有一个 worktree,叫做 main worktree


  1. 在某一个目录下使用 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 分支上


微信图片_20220512121757.png


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 吗?为什么


  1. 反复创建和删除worktree, repo/.git/wortree 目录的变化你能理解吗?
相关文章
|
19天前
|
开发工具 git
git学习四:常用命令总结,包括创建基本命令,分支操作,合并命令,压缩命令,回溯历史命令,拉取命令
这篇文章是关于Git常用命令的总结,包括初始化配置、基本提交、分支操作、合并、压缩历史、推送和拉取远程仓库等操作的详细说明。
68 1
git学习四:常用命令总结,包括创建基本命令,分支操作,合并命令,压缩命令,回溯历史命令,拉取命令
|
26天前
|
开发工具 git 开发者
关于git 解决分支冲突问题(具体操作,包含截图,教你一步一步解决冲突问题)
本文通过具体操作和截图,详细讲解了如何在Git中解决分支冲突问题,包括如何识别冲突、手动解决冲突代码、提交合并后的代码,以及推送到远程分支。
146 3
关于git 解决分支冲突问题(具体操作,包含截图,教你一步一步解决冲突问题)
|
2月前
|
缓存 开发工具 git
Git创建分支以及合并分支
在Git中,创建分支使用`git branch [branch_name]`,切换分支使用`git checkout [branch_name]`。修改文件后,通过`git add [file]`添加到暂存区,然后`git commit`提交到本地仓库。如果是新建分支的第一次推送,使用`git push origin [branch_name]`推送到远程仓库,之后可以简化为`git push`。合并分支时,使用`git merge [branch_name]`将指定分支的更改合并到当前分支。
43 2
Git创建分支以及合并分支
|
5月前
|
项目管理 开发工具 git
Git项目管理——分支(三)
Git项目管理——分支(三)
67 2
|
20天前
|
开发工具 git
Git分支使用总结
Git分支使用总结
25 1
|
2月前
|
存储 Linux 开发工具
Git基础命令,分支,标签的使用【快速入门Git】
本文详细介绍了Git版本控制系统的基础概念和常用命令,包括工作区、暂存区和版本库的区别,文件状态的变化,以及如何进行文件的添加、提交、查看状态、重命名、删除、查看提交历史、远程仓库操作和分支管理,还涉及了Git标签的创建和删除,旨在帮助读者快速入门Git。
Git基础命令,分支,标签的使用【快速入门Git】
|
2月前
|
测试技术 开发工具 git
掌握 Git 分支策略:提升你的版本控制技能
在现代软件开发中,版本控制至关重要,Git 作为最流行的分布式版本控制系统,其分支管理策略对于高效协作和代码维护尤为重要。本文介绍了几种常用的 Git 分支策略,包括主线开发模型、功能分支模型、Gitflow 工作流和 Forking 工作流,并探讨了如何根据项目需求选择合适的分支模型。通过保持 `master` 分支稳定、及时合并清理分支、使用命名规范、利用 Pull Request 进行代码审查及自动化测试等最佳实践,可以显著提升团队协作效率和软件质量。掌握这些策略将帮助开发者更好地管理代码库,加快开发流程。
|
3月前
|
开发工具 git 开发者
|
3月前
|
项目管理 开发工具 git
|
3月前
|
存储 小程序 安全
【技巧】git stash用的好,切换分支随便搞
本文详细介绍了 Git 中的 `git stash` 命令,帮助你在切换分支时临时保存未提交的更改。通过实际操作示例,展示了如何使用 `git stash` 的各种命令,如 `save`、`list`、`apply` 等。无论你是初学者还是有一定经验的开发者,都能从中受益。
57 0
【技巧】git stash用的好,切换分支随便搞