背景:
??由于架構(gòu)優(yōu)化、組件下沉、倉庫調(diào)整等原因,在工作中時(shí)常需要將倉庫A中的代碼遷移到倉庫B中,同時(shí)希望代碼遷移后,能夠保留其git歷史記錄。
目標(biāo):
- 解決A倉庫全部遷移到B倉庫,并保留git歷史記錄問題
- 解決A倉庫中部分子目錄文件遷移到B倉庫,并保留git歷史記錄問題。
- 解決2中,可能丟失部分git記錄的問題。
原理:
Git設(shè)置多個(gè)遠(yuǎn)程倉庫,并分別pull下來
??git項(xiàng)目初始化后,默認(rèn)情況下會(huì)有一個(gè)叫origin的遠(yuǎn)程倉庫。我們也可以用 git remote add repo_A [repo_A的倉庫地址]
來新增一個(gè)"遠(yuǎn)程"倉庫,然后使用git pull,將多個(gè)倉庫的代碼拉下來并merge。這樣便可以實(shí)現(xiàn)A倉庫全部遷移到B倉庫,并保留git歷史記錄。
??注意這里的[repo_A的倉庫地址]
也可以是本地倉庫路徑。比如我這里添加了兩個(gè)repo,repo-A是位于本地路徑的"遠(yuǎn)程"倉庫。
Git filter-branch 重寫歷史
??我們已經(jīng)知道了如何將A倉庫全部遷移到B倉庫,如果我們只需要將A倉庫中的部分子目錄文件遷移,就需要用到git重寫歷史的功能。git filter-branch
是git提供的重寫歷史的命令,我們可以用subdirectory-filter
來實(shí)現(xiàn)重寫git項(xiàng)目子路徑的git歷史記錄。
--subdirectory-filter <directory> 重寫子路徑的git歷史記錄
?? Only look at the history which touches the given subdirectory. The result will contain that directory (and only that) as its project root.
??subdirectory-filter
可以從git項(xiàng)目中過濾出給定子目錄的git歷史記錄,同時(shí)會(huì)把給定的子目錄作為git項(xiàng)目的根目錄。
??舉例看下效果,原始repo_A的狀態(tài)如下,有other和ugc倆個(gè)子目錄,現(xiàn)在我們只需要遷移A倉庫的ugc目錄,因此需要先把ugc目錄的git歷史記錄過濾出來。
??使用 git filter-branch --subdirectory-filter ./ugc -- --all
重寫./ugc
路徑的git歷史。可以看到,倉庫A只會(huì)保留ugc下的文件和git歷史記錄,其他的會(huì)被移除。再結(jié)合前面的原理,便可以實(shí)現(xiàn)A倉庫中部分子目錄文件遷移到B倉庫,并保留git歷史記錄
??按上述的方案已經(jīng)能夠?qū)崿F(xiàn)A倉庫中部分子目錄文件遷移到B倉庫,但是某些情況下會(huì)丟失git記錄。publishwtt是從publish模塊抽離出來的,按上面的方案提取publishwtt路徑的git歷史記錄,只能提取到新建publishwtt目錄時(shí)間點(diǎn)之后的git記錄,我們的情況是publishwtt剛從publish抽離不久,這樣很多git歷史會(huì)丟失,這是我們不愿意接受的。
?? 既然publishwtt從publish抽離來的,那么我們保留publishwtt和publish的父路徑的git歷史記錄,就不會(huì)有g(shù)it記錄丟失的問題了。但是直接使用其父路徑的歷史記錄,會(huì)把該目錄的所有子目錄的歷史記錄都保留下來,造成過多無用記錄,我們還應(yīng)該刪除bytecert、profile等路徑的git記錄。可以用到index-filter
來刪除指定文件或文件夾,以及其git記錄。
git filter-branch --force --index-filter 'git rm --cached -r --ignore-unmatch 文件路徑' --prune-empty --tag-name-filter cat -- --all
?? 該命令會(huì)遍歷所有commit記錄,刪除提交記錄中包含指定文件的記錄,如果刪除后是空提交,把空提交記錄也刪除。subdirectory-filter
和index-filter
配合使用,可以較好的實(shí)現(xiàn)A倉庫中部分子目錄文件遷移到B倉庫,并保留git歷史記錄。
實(shí)現(xiàn)過程:
??假設(shè)是要把repo A的 ugc/publish移動(dòng)到repo B的 ugc/publish里面去。
第一步:在repo A里面準(zhǔn)備要提交的目錄。
- 可以先把remote端給remove掉,這樣本地的修改一定不會(huì)影響到網(wǎng)絡(luò)上的版本(可選項(xiàng));
- 使用
git filter-branch
把需要的目錄/文件篩選出來,放到對應(yīng)目錄里面去; - 然后將此修改提交
1. git remote rm origin
2. git filter-branch --subdirectory-filter <directory: ugc/publish> -- --all
3. mkdir <directory: ugc/publish >
4. mv * <directory: ugc/publish >
5. git add .
6. git commit
??備注:一般的倉庫執(zhí)行會(huì)比較快,對于主業(yè)務(wù)倉庫,比如頭條ttmain有20多萬次commit記錄,執(zhí)行時(shí)間會(huì)很長,命令跑起來后就可以先去干其他事了。另外,3-6行為修改文件路徑,視情況決定是否需要執(zhí)行。
第二步:將準(zhǔn)備好的repo_A合并到repo_B中去。
- 切換到repo B的目錄;
- 將本地的修改后的repo A添加為repo B的一個(gè)遠(yuǎn)程倉庫,起名為from_repo_A
- 將這個(gè)名為from_repo_A的遠(yuǎn)程倉庫 pull進(jìn)來,并merge;
- 刪除遠(yuǎn)程倉庫 from_repo_A。
1. cd <repo B directory>
2. git remote add <from_repo_A> < repo_A_directory>
3. git pull <from_repo_A> master --allow-unrelated-histories
4. git remote rm <from_repo_A>
遷移完成后repo-B的sourcetree狀態(tài):
遷移子目錄可能丟失git歷史記錄問題
??前面已經(jīng)介紹過遷移子目錄可能會(huì)丟失git歷史記錄的場景,這里直接介紹實(shí)現(xiàn)過程:
??上圖已經(jīng)是使用subdirectory-filter
重寫歷史記錄得到的git項(xiàng)目,再繼續(xù)使用index-filter
刪除bytecert、profile等無關(guān)子目錄的git歷史記錄。刪除bytecert歷史記錄:
git filter-branch --force --index-filter 'git rm --cached -r --ignore-unmatch bytecert' --prune-empty --tag-name-filter cat -- --all
??該工程commit次數(shù)較多,每個(gè)刪除任務(wù)執(zhí)行時(shí)間較久,我們這里要?jiǎng)h除的比較多,可以寫一個(gè).sh腳本,跑起來后,我們就可以去干其他事了。執(zhí)行完后,將這個(gè)準(zhǔn)備好的repo_A合并到repo_B中去即可。
git filter-branch --force --index-filter 'git rm --cached -r --ignore-unmatch profile' --prune-empty --tag-name-filter cat -- --all
git filter-branch --force --index-filter 'git rm --cached -r --ignore-unmatch bytecert' --prune-empty --tag-name-filter cat -- --all
...
總結(jié):
??通過git的重寫歷史和支持設(shè)置多個(gè)遠(yuǎn)程倉庫的能力,可以實(shí)現(xiàn)跨倉庫遷移代碼,并保留git歷史記錄。