README.md · DDoSakura/sakura-git-branch-manager

# sakura-git-branch-manager

### 项目介绍
Sakura Git Branch Manager ( SGBM )

Git 分支管理工具，目标功能：

+ 自动化 Git 分支版本管理
+ 开发流程控制

### 软件架构
本项目基于 golang 开发。

流程控制与版本管理部分参考自 [http://blog.jobbole.com/109466/](http://blog.jobbole.com/109466/)。

##### 设计

分支：

+ master【唯一、主分支】
    master 分支 - 当前版本/稳定版本 - tag - RELEASE
    + v0.0.1.20180507-RELEASE
    + v0.0.2.20180513-RELEASE
    + v0.1.1-RELEASE
+ hotfixes
    热修复分支 - 修复当前版本 bugs - 须合并到 master 和 dev 分支
+ release
    release 分支 - pre-master，发布前的检查 - 须合并到 master 和 dev 分支
+ dev【唯一、主分支】
    develop 分支 - 开发中的版本 - tag - BETA / SNAPSHOT
    + v0.0.1.20180501-BETA
    + v0.0.1.20180503-BETA
    + v0.0.1.20180505-BETA
    + v0.0.1.20180507-BETA & v0.0.1.20180507-RELEASE
+ feature
    功能开发分支 - 开发具体某一模块或功能 - 须合并到 dev 分支

身份（不是硬性的规定）：

+ master
    拥有者，项目最高权限
    + 打 RELEASE 标签
    + 审查 hotfixes 分支，合并到 master、dev 分支
    + 审查 release 分支，合并到 master、dev 分支
+ manager
    管理者，开发最高权限
    + 打 BETA / SNAPSHOT 标签
    + 审查 feature 分支，合并到 dev 分支
    + 建立 hotfixes 分支
    + 建立 release 分支
    + 建立 feature 分支
+ developer
    开发者，开发权限
    + 修改 hotfixes 分支
    + 修改 release 分支
    + 修改 feature 分支

##### sgbm-config 分支

+ config.ini
    global 全局配置（包括 master、dev 的真名映射， beta 是 BETA / SNAPSHOT）
    user 用户信息
    session 登录信息
+ log.ini
    task 任务信息

### 安装教程

1. 请先确认系统中已安装 git 的命令行工具。
2. 关于 [git push 免密验证](https://segmentfault.com/n/1330000014848162)
3. 使用 `sgbm-cli init` 对项目进行初始化配置。
4. 支持已有项目迁移到本工具下管理。

### 使用说明

##### 通用部分

```bash
# 初始化（可自带版本号）【大版本升级】
sgbm-cli init [ 0.0.1 ]

# 切回主分支 - master
sgbm-cli master
# 切回主分支 - dev
sgbm-cli dev

# pull and push 一次，刷新仓库
sgbm-cli fresh
```

##### 身份管理部分

```bash
# 添加成员
sgbm-cli add [role]:[user]
# 删除成员
sgbm-cli remove [role]:[user]
# 调整当前身份
sgbm-cli login [role]:[user]
```

##### master

```bash
# 审查并通过 hotfixes/release 分支的合并请求【小/中版本升级】
sgbm-cli apply
# 发布返工任务(in hotfixes/release)
sgbm-cli task --name "task2" -m "TODO" [ -u [user] ] # --name 自动补充前缀
```

##### manager

```bash
# 将当前分支作为 BETA 版本发布(in dev)
sgbm-cli beta
# 审查并通过 feature 分支的合并请求
sgbm-cli apply
# 建立 feature(from dev)/hotfixes(from master) 分支的开发任务，并指派给某人（可选）
# 发布返工任务(in feature)
sgbm-cli task --name "task1" -m "TODO" [ -u [user] ] # --name 自动补充前缀
# 建立 release(from dev) 分支
sgbm-cli publish
```

##### develop

```bash
# 完成开发任务（in hotfixes/release/feature）
sgbm-cli publish
# 查看开发任务
sgbm-cli tasklist
# 进入指定分支进行开发
sgbm-cli workplace --id 1
sgbm-cli workplace --id 2
```

### TODO

##### 现在的版本 v0.1.0

+ [x] sgbm-cli init
+ [x] sgbm-cli master
+ [x] sgbm-cli dev
+ [x] sgbm-cli fresh
+ [x] sgbm-cli beta
+ [x] sgbm-cli add
+ [x] sgbm-cli remove
+ [x] sgbm-cli login

+ [x] bash / cmd 自动加 -p 脚本

+ [x] sgbm-cli task
+ [x] sgbm-cli tasklist
+ [x] sgbm-cli workplace
+ [x] sgbm-cli publish
+ [x] sgbm-cli apply

##### 以后的版本

###### v0.1.1

+ [ ] 开始使用本项目 v0.1.0-RELEASE 来管理
+ [ ] 完善文档、规范化
+ [ ] help 信息规范化
+ [ ] tasklist 模板间距格式化

###### v0.2.0

+ [ ] log 不覆盖（init 除外）【最好 init 也考虑在内】
+ [ ] 查看当前身份
+ [ ] 强删 task
+ [ ] 使用环境变量配置 path
+ [ ] task 保留字段 user - [no user]
+ [ ] tasklist 保留字段 user - [no login]
+ [ ] 用语规范、统一化
+ [ ] tasklist user 筛选细化

##### 再以后的版本

+ 在升级时自动执行的任务（更改项目内定义的版本之类的）
+ 其它事件的监听与自动执行的任务
+ 观察者身份（测试员），forker 身份
+ 对应的 webhooks
+ 解决冲突
+ 回滚
+ 手动 git 后的配置自动修复
+ LTS
+ 下一大版本，基于服务器
+ 用户名密码的问题是 https 导致的，支持 ssh 方式
+ 多远程仓库同步（当前写死了 origin）
+ tags 同步问题
+ 修复 --local 的问题
+ push 时带上 user 信息
+ 具体、严格的分支提交限制
+ 各种检查、判断（升级 init 时的版本不能降之类的）
+ RELEASE 关联码云的发行版功能
+ 远程/本地遗留分支的处理（远程删了之后被重建）

DDoSakura/sakura-git-branch-manager

简介

发行版 (1)

贡献者

近期动态

DDoSakura/sakura-git-branch-manager .gitee-modal { width: 500px !important; }

简介

发行版 (1)

贡献者

近期动态

搜索帮助

DDoSakura/sakura-git-branch-manager