Git Flow工作流总结

一、简介

Git Flow定义了一个项目发布的分支模型,为管理具有预定发布周期的大型项目提供了一个健壮的框架。

二、流程解析

  1. master分支存放所有正式发布的版本,可以作为项目历史版本记录分支,不直接提交代码。仅用于保持一个对应线上运行代码的 code base。

  2. develop分支为主开发分支,一般不直接提交代码

  3. feature分支为新功能分支,feature分支都是基于develop创建的,开发完成后会合并到develop分支上。同时存在多个

  4. release分支基于最新develop分支创建,当新功能足够发布一个新版本(或者接近新版本发布的截止日期),从develop分支创建一个release分支作为新版本的起点,用于测试,所有的测试bug在这个分支改。测试完成后合并到master并打上版本号,同时也合并到develop,更新最新开发分支。(一旦打了release分支之后不要从develop分支上合并新的改动到release分支),同一时间只有1个,生命周期很短,只是为了发布。

  5. 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已经支持,不用安装)

  1. 在git bash中输入:git clone --recursive git://github.com/nvie/gitflow.git d:\gitflow(指定git flow 安装目录)

2) 进入gitflow\contrib路径下,执行:msysgit-install.cmd d:\gitgit的安装目录)

  1. 打开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,增加或者修改一些节点使之成为适合自己的流程。

推荐阅读更多精彩内容