文章目录
gf
a git-flow branch management
项目Github地址
前言
工作中遇到不少因为git分支管理不规范导致的问题,导致测试效率变低,甚至于merge代码引起线上问题。
通过总结遇到的问题,借鉴netflix的分支管理,angular的commit messge规范,开发了一个工具,希望对大家的工作有所启发。
如果使用中遇到,欢迎评论中留言,或者到github中提交issue
1.遇到的问题
- 开发使用feature分支提测,多个需求并行时,feature2不包含已经提测的feature1代码。
- 提测使用feature分支,feature1和feature2均测试通过,上线时merge到master,merge之后的代码需要再次回归测试,降低测试效率。
- 测试过程中,环境被部署成其他分支,定位问题过程中才发现环境被覆盖,浪费时间。
- …
2.目标
- 保证测试代码与上线代码一致,确保线上部署的服务是100%经过测试的.
- 只测试test分支代码,代码冲突要在提测之前解决.
- 每个环境对应一个固定的代码分支,便于CI/CD,保证代码变动后第一时间部署最新代码。
- 统一的分支和tag命名规则,规范commit_msg格式,便于代码CodeReview分析。
3.分支策略
分支与环境对应关系
feature分支为短期分支,需求上线后,即可删除分支
三个长期分支Dev/Test/Release,每个分支对应一个环境,代码变更自动触发部署,保证环境代码为最新版本。
分支之间只能feature>dev>test>release单向合并
分支 | 生命周期 | 环境 | 部署 | 是否需审核 |
---|---|---|---|---|
Release | 长期 | Prod | 手动 | 是 |
Release | 长期 | Pre | 手动 | 否 |
Test | 长期 | test | 自动(代码提交时) | 否 |
Develop | 长期 | Dev | 自动(代码提交时) | 否 |
Feature | 短期 | Local | 手动 | 否 |
4.Usage
4.1 gf 中的分支管理
对应流程图中步骤 1、2、 3 、4
- 新需求开始,创建新feature分支:gf feature start <featurename>
- 开发完毕,提交到dev分支:gf feature submit <featurename>
- 自测完成提交测试:gf test
- 测试通过准备发布:gf release
4.2. 统一规范的commit message 格式
gf commit
Standardize the format of commit.
使用-b/-f 选择是否添加body/footer信息
推荐angular的commit message格式
<type>(emoji): <header>
<BLANK LINE> //空行
<body>
<BLANK LINE> //空行
<footer>
- type 用于说明 commit 的类别, header 是 commit 目的的简短描述
- *body 部分是对本次 commit 的详细描述,可以分成多行
- *footer Footer 部分只用于两种情况。BREAKING CHANGE (不兼容的改变) 和 Closes Issue 填写bug编号/或者需求编号
4.3. 支持git-flow规范的分支管理
gf feature start <branchname>
gf feature submit <branchname>
gf feature finish <branchname>
gf feature delete <branchname>
gf hotfix start <branchname>
gf hotfix start <branchname>
…
4.4. 其他接口
gf branch (切换分支)
展示仓库下分支信息,与远端同步状态,‘+’ 表示ahead,‘-’表示behind
选择分支进行切换
gf status
合并 git status & git add & git restore部分功能
选择文件 然后执行命令添加或者移除暂存区
gf tag (统一的tag格式)
create a tag in ‘v{major}.{minor}.{patch}_{date}’ format
Use -p/-m/-M to increase patch/minor/major version number
gf undo
撤销last commit提交, == git reset “HEAD^”
gf log
更加美观的commit 记录
gf inspect
仓库代码统计信息
Installation
pip install gitflo