m-git 2.5.4 → 2.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 061c41a63ff3870becb7688fd0006b85c57423d3fd909e6dde81df7756f3dc3b
-  data.tar.gz: d9da7bf09c24160ef38953892306ac3fa659400fe1742c59a621b0d6f1c6be10
+  metadata.gz: 232bed3ac9b0a7f3afe26d8e7796ce9131b4e7c2880aaafcb063c3ba909d4d14
+  data.tar.gz: 9f87f16862c5b7b63e7d37c46fcb4b84305794b93465b63c844c41851d999255
 SHA512:
-  metadata.gz: 57cef37878e9c37fe761717385a83c5237dcec0ab14057ab3013eae05ee353426031556888420322c621051d8331e6c522d65119439b61b2f260f0a3a6f0eb5f
-  data.tar.gz: 710a2e9b7de9b273b4ddd40a8e8d3d3a252e2cbd97a94bb6b66b3aeea91b21c1afc9388efd63f8102a42e986188c46a5b97f2b9bce70327461455ca3a594c72c
+  metadata.gz: 81c73e2475e07efbaa1ae6dd218797bbef22e0f8b79ab07965bcdbb902b08bb407d5c91967178fcc4361568f89884a4b952bb9669c2d7bd5bed4a9947913f889
+  data.tar.gz: 2ac247bc413df36213b3dd3a0081893c416050f9cffc50cbd8df5494cfecb0955fdaf2ca37b86eb9219878d2753f7820fc787288fb0a22f4312c39f33e4ee0fb

data/README.md

@@ -1,10 +1,10 @@
 # MGit
 
-MGit是一款ruby封装的基于Git的多仓库管理工具，可以高效的、同时的对多个Git仓库执行Git命令。
-适合于在多个仓库中进行关联开发的项目，提高git操作的效率，避免逐个执行Git命令带来的误操作风险。
+MGit 是一款 Ruby 封装的基于 Git 的多仓库管理工具，可以高效的、同时的对多个 Git 仓库执行 Git 命令。
+适合于在多个仓库中进行关联开发的项目，提高 Git 操作的效率，避免逐个执行 Git 命令带来的误操作风险。
 
 - **易用的命令**
-封装Git命令，命令和参数均由Git衍生而来，会使用Git就可以成本低上手MGit。
+封装 Git 命令，命令和参数均由 Git 衍生而来，会使用 Git 就可以成本低上手 MGit。
 
 - **直观高效的执行命令**
 提供图表化的结果展示，开发者可以快速查看命令在多个仓库的执行结果；
@@ -12,20 +12,20 @@ MGit是一款ruby封装的基于Git的多仓库管理工具，可以高效的、
 
 - **安全的执行命令**
 在执行命令前对多仓库状态进行安全检查：分支是否异常，工作区是否未提交代码等；
-对.git进行托管与Git工作区分类，避免误删丢失改动或提交；
+对 .git 进行托管与 Git 工作区分类，避免误删丢失改动或提交；
 执行存在风险的操作时，会给与风险操作提示，避免误操作；
 
 - **方便扩展**
-支持加载ruby-gem包作为插件，gem包名格式 `m-git-${suffix}`和`mgit-${suffix}`
-快速的扩展MGit的命令，增加自定义命令，扩展已有命令的功能；
-提供类似`git hook`的 hook点，方便开发者实现自定义逻辑；
+支持加载 ruby-gem 包作为插件，gem 包名格式 `m-git-${suffix}`和`mgit-${suffix}`
+快速的扩展 MGit 的命令，增加自定义命令，扩展已有命令的功能；
+提供类似`git hook`的 hook 点，方便开发者实现自定义逻辑；
 
 ## 快速开始
-  #### 1、安装MGit工具
+  #### 1、安装 MGit 工具
 
 环境要求：
 
-- 系统：支持 macOS、Ubuntu，暂时不支持 window-
+- 系统：支持 macOS、Ubuntu，暂时不支持 Windows
 - Ruby版本: >= 2.3.7
 
 ```ruby
@@ -38,21 +38,45 @@ $ gem install m-git
 
 类似于 Git 从远程 clone 新仓库, 会将多个仓库 clone 到本地;
 
-下面通过一个demo体验一下MGit命令：
+下面通过一个 demo 体验一下 MGit 命令：
 
 ```ruby
 # 2.1 建议在一个新文件夹中拉取demo
 $ mgit init -g https://github.com/baidu/m-git.git
 
 # 2.2 体验一下mgit命令
-$ mgit -l                 显示所有migt管理的仓库
+$ mgit -l                 显示所有mgit管理的仓库
 $ mgit branch --compact   查看多仓库的分支
 $ mgit status             产看仓库分支超前/落后情况
 ```
 
 
+#### 3、已有多仓库如何迁移到 MGit 管理
 
-#### 3、进一步了解MGit
+- 根据文档[配置 manifest.json](docs/config/manifest.md)
+
+  将要管理的仓库都配置到 manifest.json 中
+  
+- 将 manifest.json 放到一个仓库中管理
+
+  这个仓库同样会在 manifest.json 中描述，并且需要配置 "config-repo": true 
+  
+  这个仓库称为配置仓库，也叫做**主仓库**，其他仓库叫做**子仓库**
+     
+- 使用 `mgit init -f manifest文件路径` 初始化多仓库，命令测试 manifest.json 配置是否正常
+
+  注意这个命令不会重复拉取主仓库，只会拉取所有的子仓库到当前目录，并在当前目录创建一个.mgit
+  
+  你可以在当前目录中看到每个仓库的源码，他们的路径可以通过  manifest.json 的 dest字段配置
+  
+  你也可以在 .mgit/source-git/ 下看到所有仓库的.git, 这是 MGit 对所有仓库的托管
+  
+- 本地测试成功后，你可以提交主仓库中的 manifest.json，推送主仓库的变更到远端
+  
+- 通过 `mgit init -g 主仓库地址` 命令初始化多仓库
+  
+
+#### 4、进一步了解 MGit
 
 [常用命令](docs/use/common-commands.md)
 
@@ -60,24 +84,26 @@ $ mgit status             产看仓库分支超前/落后情况
 
 [配置多仓库](docs/config/config-env.md) 
 
+[使用 MGit 管理多仓库的案例](docs/use/how-to-start.md#4-mgit-) 
+
 [了解更多](docs/references.md)
 
 
 ## 测试
 
 单测在MGit仓库内的test文件夹下
-新建单测文件，必须以‘test_’开头,
+新建单测文件，必须以‘test_’开头
 执行单测：rake （如果报错尝试执行 bundle install）
 
 
 ## 如何贡献
 
-欢迎开发者向MGit贡献代码。如果您开发了新功能或发现了bug，欢迎给我们提交PR。
+欢迎开发者向 MGit 贡献代码。如果您开发了新功能或发现了 bug，欢迎给我们提交PR。
 
 代码贡献要求：
 1. 功能和实现应该具有通用性, 不是为了解决某个具体业务而定制的代码逻辑
-2. 代码质量高，符合Ruby编码规范
-3. 需要补充对应的单测case
+2. 代码质量高，符合 Ruby 编码规范
+3. 需要补充对应的单测 case
 
 issues贡献： 如在使用中遇到问题，请在 https://github.com/baidu/m-git/issues 新建 issues 反馈问题。
 

data/lib/m-git/command/config.rb

@@ -26,11 +26,11 @@ module MGit
           ARGV::Opt.new(OPT_LIST[:update_manifest],
                         short_key:OPT_LIST[:update_manifest_s],
                         info:"该指令用于更新mgit所使用的配置文件，如：\"mgit config -m <new_path>/manifest.json\"。",
-                        type: :boolean),
+                        type: :string),
           ARGV::Opt.new(OPT_LIST[:update_local],
                         short_key:OPT_LIST[:update_local_s],
                         info:"该指令用于更新mgit所使用的本地配置文件，如：\"mgit config -u <new_path>/local_manifest.json\"。",
-                        type: :boolean),
+                        type: :string),
           ARGV::Opt.new(OPT_LIST[:create_local],
                         short_key:OPT_LIST[:create_local_s],
                         info:"在指定目录下创建本地配置文件，若目录不存在则自动创建。如执行：\"mgit config -c /a/b/c\"，则生成本地配置文件：\"/a/b/c/local_manifest.json\"。如果未传入值，如：\"mgit config -c\"，那么若配置仓库存在的话，会在配置仓库中创建本地配置文件。",

data/lib/m-git/version.rb

@@ -1,6 +1,6 @@
 
 module MGit
-  VERSION = "2.5.4".freeze
+  VERSION = "2.5.5".freeze
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m-git
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.5.5
 platform: ruby
 authors:
 - zhangyu81
 autorequire: 
 bindir: "./"
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored2
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement