一、簡介
Git Flow定義了一個項目發佈的分支模型,爲管理具有預定發佈週期的大型項目提供了一個健壯的框架。
二、流程解析
-
master分支存放所有正式發佈的版本,可以作爲項目歷史版本記錄分支,不直接提交代碼。僅用於保持一個對應線上運行代碼的 code base。
-
develop分支爲主開發分支,一般不直接提交代碼
-
feature分支爲新功能分支,feature分支都是基於develop創建的,開發完成後會合併到develop分支上。同時存在多個
-
release分支基於最新develop分支創建,當新功能足夠發佈一個新版本(或者接近新版本發佈的截止日期),從develop分支創建一個release分支作爲新版本的起點,用於測試,所有的測試bug在這個分支改。測試完成後合併到master並打上版本號,同時也合併到develop,更新最新開發分支。(一旦打了release分支之後不要從develop分支上合併新的改動到release分支),同一時間只有1個,生命週期很短,只是爲了發佈。
-
hotfix分支基於master分支創建,對線上版本的bug進行修復,完成後直接合併到master分支和develop分支,如果當前還有新功能release分支,也同步到release分支上。同一時間只有1個,生命週期較短
第一步爲master分支配套一個develop分支。簡單來做可以本地創建一個空的develop分支,push到服務器上:
git branch –b develop
git push -u origin develop
以後這個分支將會包含了項目的全部歷史,而master分支將只包含了部分歷史。其它開發者這時應該克隆中央倉庫,建好develop分支的跟蹤分支:
git clone ssh://user@host/path/to/repo.git
git checkout -b develop origin/develop
現在每個開發都有了這些歷史分支的本地拷貝。從develop分支拉一個特性分支進行開發
git checkout -b some-feature develop
git push(如果這個功能需要多個人協作,建議push)
用老套路添加提交到各自功能分支上:編輯、暫存、提交:
git status
git add
git commit
git push(如果這個功能需要多個人協作)
添加了提交後,如果團隊使用Pull Requests,這時候可以發起一個用於合併到develop分支。否則就直接合併到本地的develop分支後push到中央倉庫
git pull origin develop
git checkout develop
git merge some-feature
git push
git branch -d some-feature
git push origin --delete some-feature (如果這個功能需要多個人協作)
第一條命令在合併功能前確保develop分支是最新的。注意,功能決不應該直接合併到master分支。
然後用一個新的分支來做發佈準備。這一步也確定了發佈的版本號:
git checkout -b release-1.0.0 develop
這個分支是清理髮布、執行所有測試、更新文檔和其它爲下個發佈做準備操作的地方,像是一個專門用於改善發佈的功能分支。只要創建這個分支並push到中央倉庫,這個發佈就是功能凍結的。任何不在develop分支中的新功能都推到下個發佈循環中。
一旦準備好了對外發布,合併修改到master分支和develop分支上,刪除發佈分支。
git checkout master
git merge release-1.0.0
git push
git checkout develop
git merge release-1.0.0
git push
git branch -d release-1.0.0
git push origin --delete release-1.0.0
發佈分支是作爲功能開發(develop分支)和對外發布(master分支)間的緩衝。只要有合併到master分支,就應該打好Tag以方便跟蹤。
git tag -a 1.0.0 -m "Initial public release" master
git push --tags
對外發布後,發現了當前版本的一個Bug,從master分支上拉出了一個Hotfix分支,提交修改以解決問題,然後直接合並回master分支
git checkout -b issue-#001 master
Fix the bug…..
git checkout master
git merge issue-#001
git push
就像發佈分支,維護分支中新加這些重要修改需要包含到develop分支中,然後才刪除這個Hotfix分支
git checkout develop
git merge issue-#001
git push
git branch -d issue-#001
三、Git Flow使用
3.1 安裝Git Flow(最新的git bash已經支持,不用安裝)
- 在git bash中輸入:git clone --recursive git://github.com/nvie/gitflow.git d:\gitflow(指定git flow 安裝目錄)
2) 進入gitflow\contrib路徑下,執行:msysgit-install.cmd d:\git(git的安裝目錄)
- 打開Git Bash命令窗口,執行git flow,輸出如下:
說明git flow 安裝成功!
3.2 Git Flow常用命令
git flow init:初始化一個現有的 git 庫,將會設置一些初始的參數,如分支前綴名等,建議用默認值。
git flow feature start [featureBranchName]: 創建一個基於'develop'的feature分支,並切換到這個分支之下。
git flow feature finish [featureBranchName]: 完成開發新特性, 合併 MYFEATURE 分支到 'develop', 刪除這個新特性分支, 切換回 'develop' 分支。
git flow feature publish [featureBranchName]:發佈新特性分支到遠程服務器,也可以使用git的push命令
git flow feature pull origin [featureBranchName]:取得其它用戶發佈的新特性分支,並簽出遠程的變更。也可以使用git的pull命令
git flow feature track [featureBranchName]:跟蹤在origin上的feature分支。
git flow release start [releaseBranchName]:開始準備release版本,從 'develop' 分支開始創建一個 release 分支。
git flow release publish [releaseBranchName]:創建 release 分支之後立即發佈允許其它用戶向這個 release 分支提交內容。
git flow release track [releaseBranchName]:簽出 release 版本的遠程變更。
git flow release finish [releaseBranchName]:歸併 release 分支到 'master' 分支,用 release 分支名打 Tag,歸併 release 分支到 'develop',移除 release 分支。
git flow hotfix start [hotfixBranchName]:開始 git flow 緊急修復,從master上建立hotfix分支。
git flow hotfix finish [hotfixBranchName]:結束 git flow 緊急修復,代碼歸併回 develop 和 master 分支。相應地,master 分支打上修正版本的 TAG。
Tips:你依舊可以繼續使用你所知道和了解的git命令按照git flow的流程走,git flow只是一個工具集合。
推薦工具:Sourcetree 下載地址:https://www.sourcetreeapp.com/,上面集成了git flow的工具包。
3.3 使用git flow命令實現分支管理流程
可以看出,上面的操作又是拉分支又是改版本又是合併, 很繁瑣。下面介紹一款插件,簡化整個流程,讓很多操作自動化。
四、使用jgitflow-maven-plugin
4.1 配置maven
<plugin>
<groupId>external.atlassian.jgitflow</groupId>
<artifactId>jgitflow-maven-plugin</artifactId>
<version>1.0-m5.1</version>
<configuration>
<localOnly>false</localOnly>
<pushFeatures>true</pushFeatures><!--是否在feature start 之後將feature分支推送到遠程倉庫-->
<pushReleases>true</pushReleases><!--是否在release start 之後將feature分支推送到遠程倉庫-->
<pushHotfixes>true</pushHotfixes><!--是否在hotfix start 之後將feature分支推送到遠程倉庫-->
<squash>false</squash>
<allowSnapshots>true</allowSnapshots>
<goals>clean</goals>
<noHotfixBuild>true</noHotfixBuild><!--是否在feature期間build項目-->
<noFeatureBuild>true</noFeatureBuild>
<noReleaseBuild>true</noReleaseBuild>
<!-- see goals wiki page for configuration options -->
<flowInitContext>
<masterBranchName>master</masterBranchName>
<developBranchName>develop</developBranchName>
<featureBranchPrefix>feature-</featureBranchPrefix>
<releaseBranchPrefix>release-</releaseBranchPrefix>
<hotfixBranchPrefix>hotfix-</hotfixBranchPrefix>
<versionTagPrefix>loan-</versionTagPrefix>
</flowInitContext>
</configuration>
</plugin>
<plugin>
<!--版本號管理插件-->
<groupId>org.codehaus.mojo</groupId>
<artifactId>versions-maven-plugin</artifactId>
<configuration>
<generateBackupPoms>false</generateBackupPoms>
</configuration>
</plugin>
官方文檔:https://bitbucket.org/atlassian/jgit-flow/wiki/Home
4.2 常用命令
mvn jgitflow:feature-start
mvn jgitflow:feature-finish
mvn jgitflow:release-start
mvn jgitflow:release-finish
mvn jgitflow:hotfix-start
mvn jgitflow:hotfix-finish
每個命令的大概意思參考第三節的git flow命令,具體的區別看下一節。
4.3 jgitflow-maven-plugin管理流程
-
無需安裝Git Flow
-
無需git flow init,在pom文件中就可以配置各個分支的前綴名等信息
-
可根據配置決定在start的時候feature、release、hotfix分支是否自動推送到遠程,建議開啓
-
feature-finish後,自動刪除feature本地和遠程分支,同理release和hotfix一樣
-
feature-finish後,自動合併到develop分支,release-finish後,自動合併到master和develop分支
4.4 pom文件參數配置表
詳細請看:https://bitbucket.org/atlassian/jgit-flow/wiki/browse/goals
五、特殊情況討論
由於Git Flow只是定義的一套常規的開發流程模型,如果公司有特殊的流程,可以靈活運用Git Flow,增加或者修改一些節點使之成爲適合自己的流程