简介

ac-gitflow 是一款为了简化分支管理操作、减少分支管理操作失误、统一分支规范而开发的命令行工具.

安装

Node.js recommends 14+

npm install ac-gitflow -g

初始化

准备工作

由于该工具使用了 Gitlab Api，因此初始化需要准备以下三种信息支持：

1. Gitlab Access Token，生成 Access Token 文档地址
2. Gitlab Api 地址，Gitlab 仓库地址 + '/api/v4'，例如：https://example.gitlab.com/api/v4

初始化方式

初始化有两种方式可选：

1. 使用命令 ac init，根据提示输入上面准备的三种信息
2. 手动创建 config.json 初始化文件并赋值，文件内容参考下面代码片段

• Windows 路径： C:\Users\用户名.ac-gitflow\config.json
• Mac 路径：/Users/用户名/.ac-gitflow/config.json

{
  "baseURL": "https://example.gitlab.com/api/v4",
  "token": "xxx",
}

分支管理

分支命名规则

1. 开发分支 feature/xxx
2. 测试分支 test/xxx
3. 修复送测问题分支 bugfix/xxx
4. 修复线上问题分支 hotfix/xxx

整体流程

以供应商功能举例，送测版本为 1.0.0

1. 基于 main 分支创建新的开发分支 feature/supplier 分支
2. 开发完成后创建 Merge Request 将 feature/supplier 合并至 test/1.0.0
3. 项目管理员合并代码送测
4. 创建 bugfix/supplier 修复送测发现的问题
5. 修复完成后创建 Merge Request 将 bugfix/supplier 合并至 test/1.0.0
6. bug 验证通过后合并至 main
7. 清理 feature/supplier、bugfix/supplier、test/1.0.0 分支

命令

1. ac feature 作用：基于远程 main 分支创建新的 feature/... 分支，如：ac feature abc 创建 feature/abc

2. ac hotfix 作用：基于远程 main 分支创建新的 hotfix/... 分支，如：ac hotfix abc 创建 hotfix/abc

3. ac submit [version] 作用：提交代码并创建 MR，同时记录送测版本信息，version 为可选参数；省略时通过终端提供的选项选择确定；若输入则仅需输入 test/... 分支除 test/ 外剩余部分，如 test/v1.0.0 则输入 v1.0.0 (需要在 MR 的源分支上运行该命令)

4. ac bugfix [feature-name] 作用：根据输入的 feature-name 获取 submit 时所记录的 version 信息作为 version 选择的默认值，并创建 bugfix/ 开头 feature-name 为后缀的分支 若省略参数则通过选择 version 反推 feature-name，若找不到对应的 feature-name 则需要手动输入

5. ac remove 作用：清理 feature-name 相关的 feature、bugfix、本地 test 分支（默认远程 test 受保护）

6. ac publish [version] 作用：选择送测版本合并至 main 上线