MGit

MGit是一款ruby封装的基于Git的多仓库管理工具,可以高效的、同时的对多个Git仓库执行Git命令。 适合于在多个仓库中进行关联开发的项目,提高git操作的效率,避免逐个执行Git命令带来的误操作风险。

  • 易用的命令 封装Git命令,命令和参数均由Git衍生而来,会使用Git就可以成本低上手MGit。

  • 直观高效的执行命令 提供图表化的结果展示,开发者可以快速查看命令在多个仓库的执行结果; 多线程并发执行多仓库命令,通过仓库缓存机制提高仓库的拉取效率;

  • 安全的执行命令 在执行命令前对多仓库状态进行安全检查:分支是否异常,工作区是否未提交代码等; 对.git进行托管与Git工作区分类,避免误删丢失改动或提交; 执行存在风险的操作时,会给与风险操作提示,避免误操作;

  • 方便扩展 支持加载ruby-gem包作为插件,gem包名格式 m-git-${suffix}mgit-${suffix} 快速的扩展MGit的命令,增加自定义命令,扩展已有命令的功能; 提供类似git hook的 hook点,方便开发者实现自定义逻辑;

快速开始

#### 1、安装MGit工具

环境要求:

  • 系统:支持 macOS、Ubuntu,暂时不支持 window-
  • Ruby版本: >= 2.3.7
$ gem install m-git

2、初始化多仓库

初始化多仓库使用 mgit init 命令;

类似于 Git 从远程 clone 新仓库, 会将多个仓库 clone 到本地;

下面通过一个demo体验一下MGit命令:

# 2.1 建议在一个新文件夹中拉取demo
$ mgit init -g https://github.com/baidu/m-git.git

# 2.2 体验一下mgit命令
$ mgit -l                 显示所有migt管理的仓库
$ mgit branch --compact   查看多仓库的分支
$ mgit status             产看仓库分支超前/落后情况

3、进一步了解MGit

常用命令

manifest文件介绍

配置多仓库

了解更多

测试

单测在MGit仓库内的test文件夹下 新建单测文件,必须以‘test_’开头, 执行单测:rake (如果报错尝试执行 bundle install)

如何贡献

欢迎开发者向MGit贡献代码。如果您开发了新功能或发现了bug,欢迎给我们提交PR。

代码贡献要求:

  1. 功能和实现应该具有通用性, 不是为了解决某个具体业务而定制的代码逻辑
  2. 代码质量高,符合Ruby编码规范
  3. 需要补充对应的单测case

issues贡献: 如在使用中遇到问题,请在 https://github.com/baidu/m-git/issues 新建 issues 反馈问题。