Git 开发流程 git-flow

Git 开发流程 git-flow


2022-05-06
development, git

安装

1
    brew install git-flow-avh

初始化项目

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
    git flow init
    # 然后一路回车
    
    Which branch should be used for bringing forth production releases?
       - main
    Branch name for production releases: [main]
    Branch name for "next release" development: [develop]
    
    How to name your supporting branch prefixes?
    Feature branches? [feature/]
    Bugfix branches? [bugfix/]
    Release branches? [release/]
    Hotfix branches? [hotfix/]
    Support branches? [support/]
    Version tag prefix? []
    Hooks and filters directory? [/data/demo/.git/hooks]

Feature 分支新功能开发

开发环节:

  1. 开启一个新分支
  2. 立即推送到远端,避免同事推送了相同的分支
1
2
3
4
5
    # 开启一个分支
    git flow feature start pre-release-config
    
    # 推送提交到远端,效果等同于 git push origin feature/pre-release-config
    git flow publish

上线环节:

  1. feature分支开发完成,代码会合并到本地 develop
  2. 开启一个 release 分支,一般分支名为版本号,如:v1.0.0.0
  3. 完成release分支,会新建一个 release 分支命名的 tag 如: v1.0.0.0
  4. 推送 develop 和 main 分支到远端
  5. 将 tag 推送到远端

以上 5 步基本都是直接完成,不会穿插其他环节,完成后线上可以基于 main 分支发布或者基于对应版本的 tag 进行部署发布了。

需要注意的是:在开启 release 分支之前,可以对多个 feature 分支进行合并。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    # feature 分支开发完成,代码会合并到 develop
    git flow feature finish
    
    # 开启 release 分支
    git flow release start v1.0.0.0
    
    # release 分支完成,新建 release 分支命名的 tag 如:v1.0.0.0,并需填写 tag 的备注信息
    git flow release finish
    
    # 以上操作除了 git flow publish 都是本地分支进行操作,
    
    # 最后需要推送 develop 和 main 分支以及 tag 到远端
    git checkout develop
    git flow publish
    
    git checkout main
    git flow publish
    
    git push --tag

Hotfix 分支功能修复

hotfix 与 feature 大同小异,主要差异体现在 release 分支,具体见下文

开发环节:

  1. 开启新分支
  2. 立即推送到到远端,避免同事推送相同的分支
1
2
3
4
5
    # 开启一个分支
    git flow feature start typo-fix
    
    # 推送提交到远端,效果等同于 git push origin hotfix/typo-fix
    git flow publish

上线环节:

  1. hotfix 分支开发完成,会直接创建 tag,并且以hotfix分支命名,但是建议带上参数 -T 重新命名
  2. 推送 develop 和 main 分支到远端
  3. 将 tag 推送到远端

可以看到与 feature 开发不同的是,hotfix 不需要通过创建 release,可以快速操作,毕竟我们是修复,需要尽快操作完成上线。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
    # hotfix 分支开发完成,并且以为 v1.0.0.1 命名建立一个新tag
    git flow hotfix finish -T v1.0.0.1
    # 如果有多个 hotfix ,建议在 finish 后跟上具体的 hotfix 分支名
    git flow hotfix finish typo-fix -T v1.0.0.1
    
    
    # 最后需要推送 develop 和 main 分支以及 tag 到远端
    git checkout develop
    git flow publish
    
    git checkout main
    git flow publish
    
    git push --tag

See Also

沪ICP备2022013452号-1