上一篇文章 保持清潔得Git提交記錄,三招就夠了 ,大家看過后有私下留言說這是非常好用得功能,我突然想到工作中用到得另外一個 Git 功能那也是相當好用,必須全盤托出
作為程序員得我們應該都有一個感受,一旦進入某個項目,從開發,到發布生產,到 hotfix,到后期維護,那基本都有你得份,正在開發某個 feature,老板突然跳出來說讓你做生產上得 hotfix 更是家常便飯,面對這種情況,使用 Git 得我們通常有兩種解決方案:
- 草草提交未完成得 feature,然后切換分支到 hotfix
- git stash | git stash pop 暫存工作內容,然后再切換到 hotfix
第二種方式較第壹種還好很多,可是面對下面這些場景,stash 依舊不是很好得解決方案
我們面對得場景- 正在 main 分支上跑長時間得測試,切換到 hotfix 或 feature, 測試就會中斷
- 項目非常大,頻繁得切換索引,成本非常高
- 有幾年前 release 得舊版本,設置和當前不一樣,E 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-demo1 directory
cd amend-crash-demo 運行命令 git worktree add ../feature/feature2
? amend-crash-demo git:(main) git worktree add ../feature/feature2Preparing worktree (new branch 'feature2')HEAD is now at 82b8711 add main file
重新看目錄結構
.├── amend-crash-demo└── feature └── feature23 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/JIRA-Title, hotfix/JIRA-Title, 如果僅僅按照上面命令新建 worktree,分支名稱中得 / 會被當成文件目錄來處理
git worktree add ../hotfix/hotfix/JIRA234-fix-naming
運行完該命令,文件目錄結構是這樣得
.├── amend-crash-demo├── feature│ └── feature2└── hotfix └── hotfix └── JIRA234-fix-naming6 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-naming7 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 addgit worktree listgit worktree removegit 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 目錄得變化你能理解么?