Git 使用規(guī)范流程以及支管理策略
團(tuán)隊(duì)開發(fā)中,遵循一個(gè)合理、清晰的Git使用流程,是非常重要的。
否則,每個(gè)人都提交一堆雜亂無章的commit,項(xiàng)目很快就會(huì)變得難以協(xié)調(diào)和維護(hù)。
下面是ThoughtBot 的Git使用規(guī)范流程。我從中學(xué)到了很多,推薦你也這樣使用Git。
第一步:新建分支
首先,每次開發(fā)新功能,都應(yīng)該新建一個(gè)單獨(dú)的分支(這方面可以參考《Git分支管理策略》)。
# 獲取主干最新代碼
$ git checkout master
$ git pull
# 新建一個(gè)開發(fā)分支myfeature
$ git checkout -b myfeature
第二步:提交分支commit
分支修改后,就可以提交commit了。
$ git add --all
$ git status
$ git commit --verbose
git add 命令的all參數(shù),表示保存所有變化(包括新建、修改和刪除)。從Git 2.0開始,all是 git add 的默認(rèn)參數(shù),所以也可以用 git add . 代替。
git status 命令,用來查看發(fā)生變動(dòng)的文件。
git commit 命令的verbose參數(shù),會(huì)列出 diff 的結(jié)果。
第三步:撰寫提交信息
提交commit時(shí),必須給出完整扼要的提交信息,下面是一個(gè)范本。
Present-tense summary under 50 characters
* More information about commit (under 72 characters).
* More information about commit (under 72 characters).
http://project.management-system.com/ticket/123
第一行是不超過50個(gè)字的提要,然后空一行,羅列出改動(dòng)原因、主要變動(dòng)、以及需要注意的問題。最后,提供對(duì)應(yīng)的網(wǎng)址(比如Bug ticket)。
第四步:與主干同步
分支的開發(fā)過程中,要經(jīng)常與主干保持同步。
$ git fetch origin
$ git rebase origin/master
第五步:合并commit
分支開發(fā)完成后,很可能有一堆commit,但是合并到主干的時(shí)候,往往希望只有一個(gè)(或最多兩三個(gè))commit,這樣不僅清晰,也容易管理。
那么,怎樣才能將多個(gè)commit合并呢?這就要用到 git rebase 命令。
$ git rebase -i origin/master
git rebase命令的i參數(shù)表示互動(dòng)(interactive),這時(shí)git會(huì)打開一個(gè)互動(dòng)界面,進(jìn)行下一步操作。
下面采用Tute Costa的例子,來解釋怎么合并commit。
pick 07c5abd Introduce OpenPGP and teach basic usage
pick de9b1eb Fix PostChecker::Post#urls
pick 3e7ee36 Hey kids, stop all the highlighting
pick fa20af3 git interactive rebase, squash, amend
# Rebase 8db7e8b..fa20af3 onto 8db7e8b
#
# Commands:
# p, pick = use commit
# r, reword = use commit, but edit the commit message
# e, edit = use commit, but stop for amending
# s, squash = use commit, but meld into previous commit
# f, fixup = like "squash", but discard this commit's log message
# x, exec = run command (the rest of the line) using shell
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out
上面的互動(dòng)界面,先列出當(dāng)前分支最新的4個(gè)commit(越下面越新)。每個(gè)commit前面有一個(gè)操作命令,默認(rèn)是pick,表示該行commit被選中,要進(jìn)行rebase操作。
4個(gè)commit的下面是一大堆注釋,列出可以使用的命令。
-
pick:正常選中
-
reword:選中,并且修改提交信息;
-
edit:選中,rebase時(shí)會(huì)暫停,允許你修改這個(gè)commit(參考這里)
-
squash:選中,會(huì)將當(dāng)前commit與上一個(gè)commit合并
-
fixup:與squash相同,但不會(huì)保存當(dāng)前commit的提交信息
-
exec:執(zhí)行其他shell命令
上面這6個(gè)命令當(dāng)中,squash和fixup可以用來合并commit。先把需要合并的commit前面的動(dòng)詞,改成squash(或者s)。
pick 07c5abd Introduce OpenPGP and teach basic usage
s de9b1eb Fix PostChecker::Post#urls
s 3e7ee36 Hey kids, stop all the highlighting
pick fa20af3 git interactive rebase, squash, amend
這樣一改,執(zhí)行后,當(dāng)前分支只會(huì)剩下兩個(gè)commit。第二行和第三行的commit,都會(huì)合并到第一行的commit。提交信息會(huì)同時(shí)包含,這三個(gè)commit的提交信息。
# This is a combination of 3 commits.
# The first commit's message is:
Introduce OpenPGP and teach basic usage
# This is the 2nd commit message:
Fix PostChecker::Post#urls
# This is the 3rd commit message:
Hey kids, stop all the highlighting
如果將第三行的squash命令改成fixup命令。
pick 07c5abd Introduce OpenPGP and teach basic usage
s de9b1eb Fix PostChecker::Post#urls
f 3e7ee36 Hey kids, stop all the highlighting
pick fa20af3 git interactive rebase, squash, amend
運(yùn)行結(jié)果相同,還是會(huì)生成兩個(gè)commit,第二行和第三行的commit,都合并到第一行的commit。但是,新的提交信息里面,第三行commit的提交信息,會(huì)被注釋掉。
# This is a combination of 3 commits.
# The first commit's message is:
Introduce OpenPGP and teach basic usage
# This is the 2nd commit message:
Fix PostChecker::Post#urls
# This is the 3rd commit message:
# Hey kids, stop all the highlighting
squash和fixup命令,還可以當(dāng)作命令行參數(shù)使用,自動(dòng)合并commit。
$ git commit --fixup
$ git rebase -i --autosquash
這個(gè)用法請(qǐng)參考這篇文章,這里就不解釋了。
第六步:推送到遠(yuǎn)程倉(cāng)庫(kù)
合并commit后,就可以推送當(dāng)前分支到遠(yuǎn)程倉(cāng)庫(kù)了。
$ git push --force origin myfeature
git push命令要加上force參數(shù),因?yàn)閞ebase以后,分支歷史改變了,跟遠(yuǎn)程分支不一定兼容,有可能要強(qiáng)行推送(參見這里)。
第七步:發(fā)出Pull Request
提交到遠(yuǎn)程倉(cāng)庫(kù)以后,就可以發(fā)出 Pull Request 到master分支,然后請(qǐng)求別人進(jìn)行代碼review,確認(rèn)可以合并到master。
#p#
如果你嚴(yán)肅對(duì)待編程,就必定會(huì)使用”版本管理系統(tǒng)”(Version Control System)。
眼下最流行的”版本管理系統(tǒng)”,非Git莫屬。
相比同類軟件,Git有很多優(yōu)點(diǎn)。其中很顯著的一點(diǎn),就是版本的分支(branch)和合并(merge)十分方便。有些傳統(tǒng)的版本管理軟件,分支操作實(shí)際上會(huì)生成一份現(xiàn)有代碼的物理拷貝,而Git只生成一個(gè)指向當(dāng)前版本(又稱”快照”)的指針,因此非??旖菀子?。
但是,太方便了也會(huì)產(chǎn)生副作用。如果你不加注意,很可能會(huì)留下一個(gè)枝節(jié)蔓生、四處開放的版本庫(kù),到處都是分支,完全看不出主干發(fā)展的脈絡(luò)。
Vincent Driessen提出了一個(gè)分支管理的策略(中文簡(jiǎn)譯版),我覺得非常值得借鑒。它可以使得版本庫(kù)的演進(jìn)保持簡(jiǎn)潔,主干清晰,各個(gè)分支各司其職、井井有條。理論上,這些策略對(duì)所有的版本管理系統(tǒng)都適用,Git只是用來舉例而已。如果你不熟悉Git,跳過舉例部分就可以了。
一、主分支Master
首先,代碼庫(kù)應(yīng)該有一個(gè)、且僅有一個(gè)主分支。所有提供給用戶使用的正式版本,都在這個(gè)主分支上發(fā)布。
Git主分支的名字,默認(rèn)叫做Master。它是自動(dòng)建立的,版本庫(kù)初始化以后,默認(rèn)就是在主分支在進(jìn)行開發(fā)。
二、開發(fā)分支Develop
主分支只用來分布重大版本,日常開發(fā)應(yīng)該在另一條分支上完成。我們把開發(fā)用的分支,叫做Develop。
這個(gè)分支可以用來生成代碼的最新隔夜版本(nightly)。如果想正式對(duì)外發(fā)布,就在Master分支上,對(duì)Develop分支進(jìn)行”合并”(merge)。
Git創(chuàng)建Develop分支的命令:
git checkout -b develop master
將Develop分支發(fā)布到Master分支的命令:
# 切換到Master分支
git checkout master
# 對(duì)Develop分支進(jìn)行合并
git merge –no–ff develop
這里稍微解釋一下,上一條命令的–no–ff參數(shù)是什么意思。默認(rèn)情況下,Git執(zhí)行”快進(jìn)式合并”(fast-farward merge),會(huì)直接將Master分支指向Develop分支。
使用–no–ff參數(shù)后,會(huì)執(zhí)行正常合并,在Master分支上生成一個(gè)新節(jié)點(diǎn)。為了保證版本演進(jìn)的清晰,我們希望采用這種做法。關(guān)于合并的更多解釋,請(qǐng)參考Benjamin Sandofsky的《Understanding the Git Workflow》。
三、臨時(shí)性分支
前面講到版本庫(kù)的兩條主要分支:Master和Develop。前者用于正式發(fā)布,后者用于日常開發(fā)。其實(shí),常設(shè)分支只需要這兩條就夠了,不需要其他了。
但是,除了常設(shè)分支以外,還有一些臨時(shí)性分支,用于應(yīng)對(duì)一些特定目的的版本開發(fā)。臨時(shí)性分支主要有三種:
* 功能(feature)分支
* 預(yù)發(fā)布(release)分支
* 修補(bǔ)bug(fixbug)分支
這三種分支都屬于臨時(shí)性需要,使用完以后,應(yīng)該刪除,使得代碼庫(kù)的常設(shè)分支始終只有Master和Develop。
四、 功能分支
接下來,一個(gè)個(gè)來看這三種”臨時(shí)性分支”。
第一種是功能分支,它是為了開發(fā)某種特定功能,從Develop分支上面分出來的。開發(fā)完成后,要再并入Develop。
功能分支的名字,可以采用feature-*的形式命名。
創(chuàng)建一個(gè)功能分支:
git checkout -b feature-x develop
開發(fā)完成后,將功能分支合并到develop分支:
git checkout develop
git merge –no-ff feature-x
刪除feature分支:
git branch -d feature-x
五、預(yù)發(fā)布分支
第二種是預(yù)發(fā)布分支,它是指發(fā)布正式版本之前(即合并到Master分支之前),我們可能需要有一個(gè)預(yù)發(fā)布的版本進(jìn)行測(cè)試。
預(yù)發(fā)布分支是從Develop分支上面分出來的,預(yù)發(fā)布結(jié)束以后,必須合并進(jìn)Develop和Master分支。它的命名,可以采用release-*的形式。
創(chuàng)建一個(gè)預(yù)發(fā)布分支:
git checkout -b release-1.2 develop
確認(rèn)沒有問題后,合并到master分支:
git checkout master
git merge –no-ff release-1.2
# 對(duì)合并生成的新節(jié)點(diǎn),做一個(gè)標(biāo)簽
git tag -a 1.2
再合并到develop分支:
git checkout develop
git merge –no-ff release-1.2
最后,刪除預(yù)發(fā)布分支:
git branch -d release-1.2
六、修補(bǔ)bug分支
最后一種是修補(bǔ)bug分支。軟件正式發(fā)布以后,難免會(huì)出現(xiàn)bug。這時(shí)就需要?jiǎng)?chuàng)建一個(gè)分支,進(jìn)行bug修補(bǔ)。
修補(bǔ)bug分支是從Master分支上面分出來的。修補(bǔ)結(jié)束以后,再合并進(jìn)Master和Develop分支。它的命名,可以采用fixbug-*的形式。
創(chuàng)建一個(gè)修補(bǔ)bug分支:
git checkout -b fixbug-0.1 master
修補(bǔ)結(jié)束后,合并到master分支:
git checkout master
git merge –no-ff fixbug-0.1
git tag -a 0.1.1
再合并到develop分支:
git checkout develop
git merge –no-ff fixbug-0.1
最后,刪除”修補(bǔ)bug分支”:
git branch -d fixbug-0.1