基于Git的代码开发测试发布流程

2018-09-25 阅读量

规范的代码开发测试发布流程让烂代码暴露在阳光下。

① 创建jira或issue问题清单。

# Title

  示例：[SPARK-01] First issue for test

# Description

  描述需要解决的问题。采用mardown语法编写。

# Assignee

  指派人。可以为空，等别人来认领。

# Milestone

  需要合入的版本。比如历史release版本。

# Labels
  问题分类标签，一般从两个维度描述：

  * 模块：SQL、Core等
  * 改动：BugFix、Improvement、NewFeature、Doc等

② 开始开发

# fork或克隆源码
git clone xxx
# 查看分支
git branch
# 切换主分支
git checkout main
# 查看分支状态
git status
# 保持主分支最新
git pull
# 基于主分支创建开发分支
git checkout -b SPARK-01

... // coding（包括中途保存的若干次commit提交）

# 如果分支名称起错，可以修改
# 修改本地分支名称(通常需要通知协作者提交最新代码，因为最后要删除远端分支)
git branch -m branch-old branch-new
# 查看变化
git status
# 查看差异
git diff HEAD HEAD^
# 临时保存，切换分支暂停开发
git stash
#切换开发分支找回修改，继续开发
git stash pop
# 提交所有变动: 提交信息保持和issue一致，-a是提交所有
git commit -m "[SPARK-01] First issue for test" -a
# 提交指定文件
git add /change/file

③ 合并commit

完成开发测试后，准备提交pr前，需要合并多次commit为一个，最终的commit信息应该和issue保持一致。

# 查看提交历史
git log
# 合并本地的多次临时提交为一次（下面是合并最近2次）
git rebase -i HEAD~2
# push分支至远端（或许已经存在）
git push --set-upstream origin SPARK-01
# 如果开发分支没有协同开发人员，通常合并多次提交后，可以选择两种方案：
# ① 先删除远端分支，再push
git push origin --delete SPARK-01
git push
# ② 通知协同开发者提交代码，然后强制更新
git push -f

④ review 代码

提交merge request发起代码review。

mr信息格式：

【类型】：BugFix/Improvement/Document/NewFeature
【严重程度】：1-Blocker/2-Critical/3-Major/4-Minor/5-Trivial
【功能模块】：SQL/Core/...
【问题描述】：详细描述问题或issue链接。
【设计描述】：详细描述代码逻辑或设计思路。 
【影响分析】：是否会影响其他模块或上线影响等
【测试思路】：详细的测试经过，其他同学参考测试报告可以进行复现。
【兼容性】：无 
 issue link: 补充issue链接便于问题追踪。

通常1～2人进行review代码，审核人必须认真仔细严谨。发生事故需要和开发者同样承担责任，责任划分可以是：37或55。

没有问题，则可以评论 +1 或 LGTM（looks good to me）

⑤ 代码合并

大的功能上线需要进行灰度发布。灰度期间，代码不能合入main主分支。main分支必须是稳定的版本。

在灰度分支运行验证没有问题之后，通常由核心开发人员将代码合入主分支。

# 切换至master分支
git checkout master
# 确保本地master是最新代码
git pull
# 切换至开发分支
git checkout dev
# rebase主分支到开发分支，如果有冲突需要解冲突
git rebase master
# 重新切换到master分支
git checkout master
# 将开发分支merge到主分支，此时已经处理过冲突，肯定不会再有冲突
git merge dev
# push到远端
git push origin master
# 删除掉开发分支
git branch -d dev

本文作者： Jeff.R
本文链接： https://stefanxiepj.github.io/archives/3fbdb086.html
版权声明： 本作品采用知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议进行许可。转载请注明出处！