git 分支管理规范
分支命名
master 分支
master 为主分支,也是用于部署生产环境的分支,需要确保master分支稳定性。master 分支一般由 release 以及 hotfix 分支合并,任何时间都不能直接修改代码。
develop 分支
develop 为开发环境分支,始终保持最新完成以及bug修复后的代码,用于前后端联调。一般开发的新功能时,feature分支都是基于develop分支创建的。
feature 分支
开发新功能时,以develop为基础创建feature分支。
分支命名时以 feature/开头,后面可以加上开发的功能模块, 命名示例:
feature/user_module、
feature/cart_module`
主线开发分支:每个迭代只有一个主线开发分支,大部分功能在这个分支上开发
命名规范: feature-${迭代发版日期}-${版本号},例如 feature-20220710-1.3.0
支线开发分支:用于主线开发分支并行的支线功能开发,由于此类功能开发周期长,与主线功能相对独立,为避免开发过程对主线分支造成影响,单独拉出支线分支
命名规范: 以主线开分支命称为前缀即可,例如 feature-20220710-1.3.0-springboot-upgrade,其中前缀feature-20220710-1.3.0 对应的主线开发分支名称
我们现在版本号:我们用产品Prd 定义的为准
test分支
test为测试环境分支,外部用户无法访问,专门给测试人员使用,版本相对稳定。
release分支
release 为预上线分支(预发布分支),UAT测试阶段使用。一般由 test 或 hotfix 分支合并,不建议直接在 release 分支上直接修改代码。
Uat 分支(同release)
Uat 分支为交付验收分支,其实和release的作用一样
hotfix 分支
线上出现紧急问题时,需要及时修复,以master分支为基线,创建hotfix分支。修复完成后,需要合并到 master 分支和 develop 分支(test/uat cherry pick 合并 同时保证问题再其他主线分支上修复)。
分支命名以hotfix/
开头的为修复分支,它的命名规则与 feature 分支类似。
分支与环境对应关系
在系统开发过程中常用的环境:
-
DEV 环境(Development environment):用于开发者调试使用
-
FAT环境(Feature Acceptance Test environment):功能验收测试环境,用于测试环境下的软件测试者测试使用
-
UAT环境 (User Acceptance Test environment):用户验收测试环境,用于生产环境下的软件测试者测试使用
-
PRO 环境(Production environment):生产环境
对应关系:
分支 | 功能 | 环境 | 可访问 | 合并人员 |
---|---|---|---|---|
master | 主分支,稳定版本 | PRO | 是 | 运维人员管理 |
develop | 开发分支,最新版本 | DEV | 是 | 研发人员 |
feature | 开发分支,实现新特性 | 否 | 研发人员 | |
test | 测试分支,功能测试 | FAT | 是 | 测试人员管理 |
release(cat) | 预上线分支,发布新版本 | UAT | 是 | 测试人员、运维人员管理 |
hotfix | 紧急修复分支,修复线上bug | 否 | 运维人员管理 |
分支合并流程规范
业界常见的两大主分支(master、develop)、三个辅助分支(feature、release、hotfix)的生命周期:
以上生命周期仅作参考,不同开发团队可能有不同的规范,可自行灵活定义。
例如我们团队在开发时,至少需要保证以下流程:
-
develop 分支和 hotfix 分支,必须从 master 分支检出
-
由 develop 分支合并到 test 分支
-
功能测试无误后,由 test 分支合并到uat 分支
-
UAT测试通过后,从master 拉 release 分支将uat 和 新拉的 release中 , 线上验证没问题再 合并到 master分支
-
对于工作量小的功能开发(工时小于1天),可以直接在devolop 分支进行开发,否则由 develop 分支检出 feature 分支进行开发,开发完后合并到develop 分支
具体操作流程:
产品根据需求的优先级提前做好规划,确定每个迭代需要完成的需求,并规划好迭代的版本和评估大致的上线日期,基于产品规划的迭代,研发即可介入需求实现的设计和研发,在研发的过程中,Git需遵循如下流程
-
研发组长基于develop分支创建feature类的分支,并将该分支推送到远程,分支名: feature-版本号;示例: feature-3.7.0
-
研发同事将feature-3.7.0拉取到本地,然后在本地feature-3.7.0开发。
-
研发完成个人任务,并自测通过后,即可将【本地】feature-3.7.0的分支推送到【远程】feature-3.7.0 ,并将feature分支合并到develop分支,把develop部署到开发联调环境中进行联调
-
联调通过后,研发人员发起测试申请,转入测试阶段。测试人员把feature-3.7.0合并到test分支,然后test分支部署到测试环境进行测试
-
测试过程中发现的bug,研发人员仍在feature-3.7.0上修复,修复完再通知测试人员(每次可多修复一些,减少部署测试环境的次数),测试人员再通过合并到test分支的方式部署到测试环境,如此反复
-
测试结束后,测试人员将test分支合并到uat分支,uat分支部署到UAT环境进行产品验收 (这个可以按照具体要上uat的内容 按需发布)
-
产品验收通过后,研发组长从master分支拉出相同版本号的release分支,示例: release-3.7.0,然后把UAT分支合并到release-3.7.0,由运维同事把release-3.7.0发到正式环境,开始线上验证
-
线上验证通过后,研发组长将release-3.7.0合并到master,打tag,并删除相应的主线feature分支
-
如果线上验证不通过,则运维直接把master分支部署到正式环境来实现回滚,相应的release-3.7.0分支删除,其它分支不要删除
分支版本号:
prd tapt. 蓝湖 版本号 保持一致
Git Commit Message规范
Git commit message规范指提交代码时编写的规范注释,编写良好的Commit messages可以达到3个重要的目的:
-
加快代码review的流程
-
帮助我们编写良好的版本发布日志
-
让之后的维护者了解代码里出现特定变化和feature被添加的原因
Angular Git Commit Guidelines
业界应用的比较广泛的是Angular Git Commit Guidelines:
<type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer>
-
type:提交类型
-
scope:可选项,本次 commit 波及的范围
-
subject:简明扼要的阐述下本次 commit 的主旨,在
Angular Git Commit Guidelines
中强调了三点。使用祈使句,首字母不要大写,结尾无需添加标点 -
body: 同样使用祈使句,在主体内容中我们需要把本次 commit 详细的描述一下,比如此次变更的动机
-
footer: 描述下与之关联的 issue 或 break change
简易版
项目中实际可以采用简易版规范:
<type>(<scope>):<subject>
type规范
Angular Git Commit Guidelines
中推荐的type类型如下:
-
feat: 新增功能
-
fix: 修复bug
-
docs: 仅文档更改
-
style: 不影响代码含义的更改(空白、格式设置、缺失 分号等)
-
refactor: 既不修复bug也不添加特性的代码更改
-
perf: 改进性能的代码更改
-
test: 添加缺少的测试或更正现有测试
-
chore: 对构建过程或辅助工具和库(如文档)的更改
除此之外,还有一些常用的类型:
-
delete:删除功能或文件
-
modify:修改功能
-
build:改变构建流程,新增依赖库、工具等(例如webpack、gulp、npm修改)
-
test:测试用例的新增、修改
-
ci:自动化流程配置修改
-
revert:回滚到上一个版本
单次提交注意事项
-
提交问题必须为同一类别
-
提交问题不要超过3个
-
提交的commit发现不符合规范,
git commit --amend -m "新的提交信息"
或git reset --hard HEAD
重新提交一次
配置.gitignore文件
.gitignore
是一份用于忽略不必提交的文件的列表,项目中可以根据实际需求统一.gitignore
文件,减少不必要的文件提交和冲突,净化代码库环境。
通用文件示例:
HELP.md target/ !.mvn/wrapper/maven-wrapper.jar !**/src/main/**/target/ !**/src/test/**/target/ ## STS ### .apt_generated .classpath .factorypath .project .settings .springBeans .sts4-cache ## IntelliJ IDEA ### .idea *.iws *.iml *.ipr ## NetBeans ### /nbproject/private/ /nbbuild/ /dist/ /nbdist/ /.nb-gradle/ build/ !**/src/main/**/build/ !**/src/test/**/build/ ## VS Code ### .vscode/ # Log file *.log /logs* # BlueJ files *.ctxt # Mobile Tools for Java (J2ME) .mtj.tmp/ # Package Files # *.jar *.war *.ear *.zip *.tar.gz *.rar *.cmd
其他
此外,还有一些其他建议:
-
master 分支的每一次更新,都建议打 tag 添加标签,通常为对应版本号,便于管理
-
feature分支、hotfix分支在合并后可以删除,避免分支过多管理混乱
-
每次 pull 代码前,提交本地代码到本地库中,否则可能回出现合并代码出错,导致代码丢失
-
每次提交说明清楚,“小步”前进
如何解决合并冲突
feature(或hotix)分支合并到develop(或test、uat)冲突:
1、从develop分支checkout一个临时分支tmp_develop_XXX(或tmp_test_XXX),
2、然后把feature合并到tmp_develop_XXX(或tmp_test_XXX),合并过程的代码冲突在tmp__develop_XXX(或tmp_test_XXX)上解决(注意,不是在feature上,也不是在develop(或test)上)
3、解决完冲突后,把tmp_develop_XXX(或tmp_test_XXX)合并到develop(或test)
4、删除tmp_develop_XXX(或tmp_test_XXX)
关于maven仓库的管理
1、目前maven仓库deploy操作暂时在develop/test/uat 分支进行,大家不要在其它分支上进行deploy操作,相关的操作规范正在完善
2、将来计划,计划再弄一个开发专有maven私服,以后会有两套maven私服,以后的规范是以我们有两套私服为前提
常见问题
1、release分支发布到【正式环境】,在【正式环境】验证发现bug时,在哪个分支修复
直接在release分支修复。修复完再发【正式环境】,再【线上验证】
2、线上验收通过后,支线开发分支是否可以删除
如果支线开发分支已经合并到主线开发分支,则可以放心删除 如果支线开发分支的代码没有合并的到主线开发分支,则说明此次线上验证并没有此分支的代码,需要找相应的开发人员问清楚后处理
3、开发人员可以在哪些分支上【提交】代码
feature分支release分支,只有release分支在线上验证发现bug时,才能在release分支提交代码hotfix分支其它一律禁止直接提交代码,
4、开发人员可以向哪些分支【合并】代码
develop分支,主线featrue分支,
5、任何情况下,绝对禁止develop合并到其它任何分支(当然,有的工程仍没有完成规范改造,改造过程 中暂不用考虑此条)
相关文章:
git 分支管理规范
分支命名 master 分支 master 为主分支,也是用于部署生产环境的分支,需要确保master分支稳定性。master 分支一般由 release 以及 hotfix 分支合并,任何时间都不能直接修改代码。 develop 分支 develop 为开发环境分支,始终保持…...

Spring Cloud Gateway 详解:构建高效的API网关解决方案
Spring Cloud Gateway 详解:构建高效的API网关解决方案 Spring Cloud Gateway 是 Spring Cloud 生态系统中用于构建 API 网关的核心组件。它基于 Spring WebFlux 构建,旨在提供简单且有效的方式来路由和增强 API 请求。以下是 Spring Cloud Gateway 的详…...

基于Quartus Prime18.1的安装与FPGA的基础仿真教程
Quartus是一种美国科技公司Intel(英特尔)公司开发的FPGA(现场可编辑门阵列)设计编译软件,用作设计、仿真、综合和布局、支持多种编程语言,包括VHDL、Verilog等,并具有丰富的功能和工具库&#x…...
AJAX 和 XML:现代 Web 开发的关键技术
AJAX 和 XML:现代 Web 开发的关键技术 引言 在当今的 Web 开发领域,AJAX 和 XML 是两项至关重要的技术。AJAX(Asynchronous JavaScript and XML)允许网页在不重新加载整个页面的情况下,与服务器交换数据和更新部分网页内容。而 XML(eXtensible Markup Language)则是一…...
vue实现图片预览
在 Vue 中实现图片预览功能,通常涉及监听文件输入的变化,并在用户选择文件后,使用 FileReader API 来读取文件内容,然后显示这个内容作为图片的预览。以下是一个简单的 Vue 组件示例,它实现了图片预览功能:…...

C语言入门系列:流程控制
一,C代码执行顺序 默认情况下,C语言程序从main()函数开始执行,随后按源代码中语句出现的顺序逐一执行。 这意味着,如果不考虑任何控制结构,程序会自上而下,逐行执行每条语句,直到遇到函数调用…...

【深度学习】NLP,Transformer讲解,代码实战
文章目录 1. 前言2. Transformer结构训练过程1. 输入嵌入和位置编码2. 编码器层2.1 单头的注意力机制(便于理解)2.2 多头的注意力机制(Transformer真实使用的)2.3 残差连接和层归一化2.4 前馈神经网络(FFN)2.5 残差连接和层归一化2.6 总结 3. 解码器层 推…...
ES6 .entries用法
.entries() 返回数组的可迭代对象itarator,可以通过for of 来遍历数组或对象的值。但是它们的写法不一样。 数组用法 obj [apple,bananer,orange] for(let [i,v] of obj.entries()){console.log(i)console.log(v) } //输出 // 0 // apple // 1 // bananer // 2 //orange对象…...

【LeetCode 动态规划】买卖股票的最佳时机问题合集
文章目录 1. 买卖股票的最佳时机含冷冻期 1. 买卖股票的最佳时机含冷冻期 题目链接🔗 🍎题目思路: 🍎题目代码: class Solution { public:int maxProfit(vector<int>& prices) {int n prices.size();ve…...
python学习:语法(2)
目录 对象的布尔值 分支结构 双分支结构 多分支结构 嵌套if的使用 条件表达式 Pass语句 range()函数的使用 流程控制语句 对象的布尔值 Python一切皆对象,所有对象都有一个布尔值,通过内置函数bool()获取对象的布尔值 这些…...

经典电源电路基础(变压-整流-滤波-稳压)
1.电源电路的功能和组成 电子电路中的电源一般是低压直流电,先把220v交流电变换成低压直流电,再用整流电路变成脉动的直流电,最后用滤波电路滤除掉脉动直流中的交流成分后才能得到直流电。有的电子设备对电源的质量要求很高,所以…...

生成式人工智能备案办理指南,深度解析大模型备案全流程
早在2023年年初,国家互联网信息办公室、工业和信息化部、公安部针对深度合成服务制定的《互联网信息服务深度合成管理规定》(“《深度合成管理规定》”)顺利施行,其明确了深度合成服务相关方的义务与主体责任,强化了对…...
1527. 患某种疾病的患者
1527. 患某种疾病的患者 题目链接:1527. 患某种疾病的患者 代码如下: # Write your MySQL query statement below select patient_id,patient_name,conditions from Patients where conditions like "DIAB1%" or conditions like "% DI…...

【C/C++】【学生成绩管理系统】深度剖析
可接各类C/C管理系统课设 目录 实现功能 部分1:系统设置和主菜单 1. 引入头文件 2. 定义结构体 3. 函数声明 4. 主函数 部分2:添加学生信息 部分3:删除学生信息 部分4:修改学生信息 部分5:查询学生信息 部分…...
C++作业第四天
#include <iostream> using namespace std; class Per { private: string name; int age; int *high; double *weight; public: //构造函数 Per() { cout << "Per的无参构造" << endl; } Per(str…...

设计模式之工厂方法模式(Factory Method Pattern)
目录 1.1、前言1.2、工厂方法模式简介1.2.1、工厂方法模式的主要特点1.2.2、工厂方法模式的主要结构1.2.3、使用工厂方法模式的好处 1.3、SpringBoot中那些场景使用了工厂方法模式1.4、日常工作中那些业务场景可以使用工厂方法模式1.5、工厂方法模式实战(以某商场一…...
API接口设计的18条规范
API接口设计的18条规范 签名 目的:防止数据被篡改 实现方法: 接口请求方将请求参数、时间戳和密钥拼接成一个字符串使用MD5等hash算法生成签名sign在请求参数或请求头中增加sign参数,传递给API接口API接口网关服务验证传递的sign值&#…...
adb简单使用命令
1. 查看当前连接的设备 adb devices 2. 文件路径 adb install apk 注意文件路径中不能有中文 3. adb shell ps Toplogcatlogcat可以结合greplogcat *:w 显示警告级别以上de 4. adb uninstall 软件名 1.软件名如何查看? 使用命令adb shell pm list packages会…...

构建 deno/fresh 的 docker 镜像
众所周知, 最近 docker 镜像的使用又出现了新的困难. 但是不怕, 窝们可以使用曲线救国的方法: 自己制作容器镜像 ! 下面以 deno/fresh 举栗, 部署一个简单的应用. 目录 1 创建 deno/fresh 项目2 构建 docker 镜像3 部署和测试4 总结与展望 1 创建 deno/fresh 项目 执行命令…...
数据库 | 数据库设计的步骤
1.需求分析 调查机构情况与熟悉业务活动,明确用户的需求,确定系统的边界,生成数据字典和用户需求规格说明书 2.概念结构设计 将从需求分析中得到的用户需求抽象为概念模型,设计E-R模型 3.逻辑结构设计 将E-R图转换为和DBMS相…...

深度学习在微纳光子学中的应用
深度学习在微纳光子学中的主要应用方向 深度学习与微纳光子学的结合主要集中在以下几个方向: 逆向设计 通过神经网络快速预测微纳结构的光学响应,替代传统耗时的数值模拟方法。例如设计超表面、光子晶体等结构。 特征提取与优化 从复杂的光学数据中自…...

7.4.分块查找
一.分块查找的算法思想: 1.实例: 以上述图片的顺序表为例, 该顺序表的数据元素从整体来看是乱序的,但如果把这些数据元素分成一块一块的小区间, 第一个区间[0,1]索引上的数据元素都是小于等于10的, 第二…...

CTF show Web 红包题第六弹
提示 1.不是SQL注入 2.需要找关键源码 思路 进入页面发现是一个登录框,很难让人不联想到SQL注入,但提示都说了不是SQL注入,所以就不往这方面想了 先查看一下网页源码,发现一段JavaScript代码,有一个关键类ctfs…...

【Oracle APEX开发小技巧12】
有如下需求: 有一个问题反馈页面,要实现在apex页面展示能直观看到反馈时间超过7天未处理的数据,方便管理员及时处理反馈。 我的方法:直接将逻辑写在SQL中,这样可以直接在页面展示 完整代码: SELECTSF.FE…...

【网络安全产品大调研系列】2. 体验漏洞扫描
前言 2023 年漏洞扫描服务市场规模预计为 3.06(十亿美元)。漏洞扫描服务市场行业预计将从 2024 年的 3.48(十亿美元)增长到 2032 年的 9.54(十亿美元)。预测期内漏洞扫描服务市场 CAGR(增长率&…...
1688商品列表API与其他数据源的对接思路
将1688商品列表API与其他数据源对接时,需结合业务场景设计数据流转链路,重点关注数据格式兼容性、接口调用频率控制及数据一致性维护。以下是具体对接思路及关键技术点: 一、核心对接场景与目标 商品数据同步 场景:将1688商品信息…...

深入理解JavaScript设计模式之单例模式
目录 什么是单例模式为什么需要单例模式常见应用场景包括 单例模式实现透明单例模式实现不透明单例模式用代理实现单例模式javaScript中的单例模式使用命名空间使用闭包封装私有变量 惰性单例通用的惰性单例 结语 什么是单例模式 单例模式(Singleton Pattern&#…...
质量体系的重要
质量体系是为确保产品、服务或过程质量满足规定要求,由相互关联的要素构成的有机整体。其核心内容可归纳为以下五个方面: 🏛️ 一、组织架构与职责 质量体系明确组织内各部门、岗位的职责与权限,形成层级清晰的管理网络…...

Java-41 深入浅出 Spring - 声明式事务的支持 事务配置 XML模式 XML+注解模式
点一下关注吧!!!非常感谢!!持续更新!!! 🚀 AI篇持续更新中!(长期更新) 目前2025年06月05日更新到: AI炼丹日志-28 - Aud…...

【Linux】Linux 系统默认的目录及作用说明
博主介绍:✌全网粉丝23W,CSDN博客专家、Java领域优质创作者,掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java技术领域✌ 技术范围:SpringBoot、SpringCloud、Vue、SSM、HTML、Nodejs、Python、MySQL、PostgreSQL、大数据、物…...