Git 分支设计规范
概述
这篇文章分享 Git 分支设计规范,目的是提供给研发人员做参考。
规范是死的,人是活的,希望自己定的规范,不要被打脸。
在说 Git 分支规范之前,先说下在系统开发过程中常用的环境。
简称 | 全称 |
---|---|
DEV | Development environment |
FAT | Feature Acceptance Test environment |
UAT | User Acceptance Test environment |
PRO | Production environment |
- DEV 环境:用于开发者调试使用。
- FAT 环境:功能验收测试环境,用于测试环境下的软件测试者测试使用。
- UAT 环境:用户验收测试环境,用于生产环境下的软件测试者测试使用。
- PRO 环境:就是生产环境。
比如,项目域名为:http://www.abc.com
,那么相关环境的域名可这样配置:
- DEV 环境:本地配置虚拟域名即可
- FAT 环境:
http://fat.abc.com
- UAT 环境:
http://uat.abc.com
- PRO 环境:
http://www.abc.com
接下来,针对不同的环境来设计分支。
分支
分支 | 名称 | 环境 | 可访问 |
---|---|---|---|
master | 主分支 | PRO | 是 |
release | 预上线分支 | UAT | 是 |
hotfix | 紧急修复分支 | DEV | 否 |
develop | 测试分支 | FAT | 是 |
feature | 需求开发分支 | DEV | 否 |
master 分支
master
为主分支,用于部署到正式环境(PRO),一般由 release
或 hotfix
分支合并,任何情况下不允许直接在 master 分支上修改代码。
release 分支
release
为预上线分支,用于部署到预上线环境(UAT),始终保持与 master
分支一致,一般由 develop
或 hotfix
分支合并,不建议直接在 release
分支上直接修改代码。
如果在 release
分支测试出问题,需要回归验证 develop
分支看否存在此问题。
hotfix 分支
hotfix
为紧急修复分支,命名规则为 hotfix-
开头。
当线上出现紧急问题需要马上修复时,需要基于 release
或 master
分支创建 hotfix
分支,修复完成后,再合并到 release
或 develop
分支,一旦修复上线,便将其删除。
develop 分支
develop
为测试分支,用于部署到测试环境(FAT),始终保持最新完成以及 bug 修复后的代码,可根据需求大小程度确定是由 feature
分支合并,还是直接在上面开发。
一定是满足测试的代码才能往上面合并或提交。
feature 分支
feature
为需求开发分支,命名规则为 feature-
开头,一旦该需求上线,便将其删除。
这么说可能有点不容易理解,接下来举几个开发场景。
开发场景
新需求加入
有一个订单管理的新需求需要开发,首先要创建一个 feature-order
分支,问题来了,该分支是基于哪个分支创建?
如果 存在 未测试完毕的需求,就基于 master
创建。
如果 不存在 未测试完毕的需求,就基于 develop
创建。
需求在
feature-order
分支开发完毕,准备提测时,要先确定develop
不存在未测试完毕的需求,这时研发人员才能将将代码合并到develop
(测试环境)供测试人员测试。测试人员在
develop
(测试环境) 测试通过后,研发人员再将代码发布到release
(预上线环境)供测试人员测试。测试人员在
release
(预上线环境)测试通过后,研发人员再将代码发布到master
(正式环境)供测试人员测试。测试人员在
master
(正式环境) 测试通过后,研发人员需要删除feature-order
分支。
普通迭代
有一个订单管理的迭代需求,如果开发工时 < 1d,直接在 develop
开发,如果开发工时 > 1d,那就需要创建分支,在分支上开发。
开发后的提测上线流程 与 新需求加入的流程一致。
修复测试环境 Bug
在 develop
测试出现了Bug,如果修复工时 < 2h,直接在 develop
修复,如果修复工时 > 2h,需要在分支上修复。
修复后的提测上线流程 与 新需求加入的流程一致。
修改预上线环境 Bug
在 release
测试出现了Bug,首先要回归下 develop
分支是否同样存在这个问题。
如果存在,修复流程 与 修复测试环境 Bug流程一致。
如果不存在,这种可能性比较少,大部分是数据兼容问题,环境配置问题等。
修改正式环境 Bug
在 master
测试出现了Bug,首先要回归下 release
和 develop
分支是否同样存在这个问题。
如果存在,修复流程 与 修复测试环境 Bug流程一致。
如果不存在,这种可能性也比较少,大部分是数据兼容问题,环境配置问题等。
紧急修复正式环境 Bug
需求在测试环节未测试出 Bug,上线运行一段时候后出现了 Bug,需要紧急修复的。
我个人理解紧急修复的意思是没时间验证测试环境了,但还是建议验证下预上线环境。
如果
release
分支存在未测试完毕的需求,就基于master
创建hotfix-xxx
分支,修复完毕后发布到master
验证,验证完毕后,将master
代码合并到release
和develop
分支,同时删掉hotfix-xxx
分支。如果
release
分支不存在未测试完毕的需求,但develop
分支存在未测试完毕的需求,就基于release
创建hotfix-xxx
分支,修复完毕后发布到release
验证,后面流程与上线流程一致,验证完毕后,将master
代码合并到develop
分支,同时删掉hotfix-xxx
分支。如果
release
和develop
分支都不存在未测试完毕的需求, 就直接在develop
分支上修复完毕后,发布到release
验证,后面流程与上线流程一致。
并行提测
在一个项目中并行开发了两个需求,并行提测,但是上线日期不同。
我能想到的两种方案:
- 再部署一套可供测试人员测试的分支
- 使用
git cherry-pick
“挑拣”提交
对于并行提测,你有好的方案吗?欢迎留言。
Commit 日志规范
提交信息一定要认真填写!
建议参考规范:<type>(scope):<subject>
比如:fix(首页模块):修复弹窗 JS Bug。
type
表示 动作类型,可分为:
- fix:修复 xxx Bug
- feat:新增 xxx 功能
- test:调试 xxx 功能
- style:变更 xxx 代码格式或注释
- docs:变更 xxx 文档
- refactor:重构 xxx 功能或方法
scope
表示 影响范围,可分为:模块、类库、方法等。
subject
表示 简短描述,最好不要超过 60 个字,如果有相关 Bug 的 Jira 号,建议在描述中加上。
小结
暂时就想到这么多,规范这东西不是一成不变的,供参考。
推荐阅读
Git 分支设计规范的更多相关文章
- Git 分支
Git 保存的不是文件的变化或者差异,而是一系列不同时刻的文件快照,某一次的提交指向这处时刻的文件快照,看起来就像每次提交都保存了当时的文件,连续的提交形成一条长链 分支 指向某一个特定的提交,不同的 ...
- Git分支管理
一.Git分支的使用 查看分支: git branch 创建分支: git branch branch1 切换到branch1 git checkout branch1 再用git branch查看, ...
- Git分支的前世今生
摘自Jack__CJ CSDN博客,写得很好,保存一下. 导读 几乎所有的版本控制系统都以某种形式支持分支. 使用分支意味着你可以把你的工作从开发主线上分离开来,以免影响开发主线. 在很多版本控制系 ...
- GIT分支管理模型
GIT分支管理模型 link: git-branching-model 主分支(Main branches) 项目两个常驻分支: master 主干分支(锁定),仅用于发布新版本,平时不能在上面干活, ...
- Git详解之三 Git分支
相关文档 — 更多 Git 基础培训.ppt GIT 使用经验.ppt GIT 介绍.pptx GIT 分支管理是一门艺术.docx Eclipse上GIT插件EGIT使用手册.docx git/gi ...
- git初体验(三)git分支
分支的理念就是分身,就像孙悟空拔出猴毛变出很多跟自己一模一样的猴子,然后每个猴子做自己的事情互不干涉,等到所有猴子做完之后,猴子集合来合并劳动成果,然后悟空就把那些猴子猴孙门统统收回了. 你创建了一个 ...
- 如何在终端实时展现git分支
在微博上看到ghosTM55在终端可以实时展现出当前运行的分支,觉得很奇特,于是google了一把.这里面存在两个内容,第一个bash,第二个是git bash基础: 了解到linux的shell存在 ...
- php 通过exec 创建git分支失败
今天给我们自己的发布系统增加一个新建分支的功能,操作比较简单,但是使用php执行shell命令的时候总是无法push分支到远程,但是登陆服务器执行却是可以的 新建分支命令如下 git fetch -- ...
- 开发与测试整体过程中的Git分支merge流程
开发与测试整体过程中的Git分支merge流程 Git分支merge之开发流程 首先在Gitlab上有个仓库存储着原始的项目代码,其中包含一个叫master的分支.然后可能按功能进行分配,由不同的开发 ...
随机推荐
- 《大厂面试》京东+百度一面,不小心都拿了Offer
你知道的越多,你不知道的越多 点赞再看,养成习惯 本文 GitHub https://github.com/JavaFamily 已收录,有一线大厂面试点思维导图,也整理了很多我的文档,欢迎Star和 ...
- a标签属性href值为#和javasrcript:void(0)的区别
当我们需要一个空链接时,通常有两种方法: <a href="#">这个一个空链接</a> <a href="javascript:void( ...
- Android/Unity大乱斗-完整双方集成交互指南
这是一个很长很长的story!-芝麻粒儿创作 开篇 源码地址:GitHub 本文目的,将Unity集成到Android端,学完本文后你可以做到 Android任意布局加载Unity 3D场景 任意操作 ...
- a标签点击触发 layer open 只显示背景解决
问题:公司网站突然说有个查看信息的点击不好使了,有时候点击无反应,但是href执行了,有时候弹出只有背景,不显示内容.网上找了a标签的各种方法尝试后,均不能解决. 代码:类似如下,method()方法 ...
- Java框架之Spring02-AOP-动态代理-AspectJ-JdbcTemplate-事务
AOP 动态代理 代理设计模式的原理:使用一个代理将原本对象包装起来,然后用该代理对象”取代”原始对象.任何对原始对象的调用都要通过代理.代理对象决定是否以及何时将方法调用转到原始对象上. 代理模式的 ...
- BZOJ4559&P3270[JLoi2016]成绩比较
题目描述 \(G\)系共有\(n\)位同学,\(M\)门必修课.这\(N\)位同学的编号为\(0\)到\(N-1\)的整数,其中\(B\)神的编号为\(0\)号.这\(M\)门必修课编号为\(0\)到 ...
- 数学基础系列(六)----特征值分解和奇异值分解(SVD)
一.介绍 特征值和奇异值在大部分人的印象中,往往是停留在纯粹的数学计算中.而且线性代数或者矩阵论里面,也很少讲任何跟特征值与奇异值有关的应用背景. 奇异值分解是一个有着很明显的物理意义的一种方法,它可 ...
- Nginx代理服务——反向代理
Nginx可以代理的服务 正向代理,例如翻墙 反向代理 正向和反向代理的区别 区别在于代理的对象不一样 正向代理:代理的对象是客户端 反向代理:代理的对象是服务器 配置语法 Synta ...
- IDEA使用 磨刀霍霍向代码
工欲善其事,必先利其器 ,当下有数不清的 Java 程序员将石器时代的 Eclipse 替换成了现代化的智能开发工具 InteliJ IDEA ,写代码的小日子过得不亦乐乎(玩笑话,两者各有千秋,看个 ...
- git工作中总结
# .克隆到本地 git clone url git clone -b 分支 url # 注意:克隆完成后,要删除.git隐藏文件夹 # .修改代码 # .生成master git init git ...