bigkeeper 0.8.5 → 0.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a86d4f15a32e4d04576c9e244da060e5c1fb44
-  data.tar.gz: 138d77e976d07a10306b7e16b7462f03773785fa
+  metadata.gz: f110eccd6b2a0185f889a7af2324d30da13c9477
+  data.tar.gz: 40582adaa6066a3710e6b2f3ea7686b2ef7e991e
 SHA512:
-  metadata.gz: 7b2914cc67868b6fd125b5fbe615012efbb70bb8c8e78edf5ae90aa33a98d4d81b1675c72ae8db80e527e214f0b0aaf9961678f37a7196dc278f238f81c9bd07
-  data.tar.gz: 1e7ba514b4724074df6c28bae6f1a64d83810399e829087db8de59885317b297d6df96336c0ac3fd1974185abc38ece3ba4d3d1703f5314d52ea675632a2430a
+  metadata.gz: b3d3418c579636978d527e9618c4d2a0157e609d08e41213c1af69fb3f339bf281c15cc62c53dbb6dbc2985f5a91425597239d5eb71e53b6610e608bda7c3184
+  data.tar.gz: f6e1804ea25f309520dbafa108b192a26d6f54a7c52dd610e0efff8ba748b69893dfe9776ee70dfd2e004d76f1f74ed49e6619aab0e7b89f5136cb7544edcb07

data/README.md

@@ -1,11 +1,11 @@
-![](./resources/banner.png)
-
 [English](./docs/en-US/README.md)
 
 ---
 
 # bigkeeper
 
+![](./resources/banner.png)
+
 [![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/big-keeper/maintainability)
 [![Gem Version](https://badge.fury.io/rb/bigkeeper.svg)](https://rubygems.org/gems/bigkeeper)
@@ -13,11 +13,11 @@
 [![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-keeper/blob/master/LICENSE)
 [![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)
 
-bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，使用这个工具后，开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
+bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，旨在帮助有模块化需求的团队更轻松的渡过“半模块化”尴尬期。
 
-> 注：目前只支持依赖 CocoaPods 管理的模块化工程。
+使用这个工具后，开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
 
-我们借鉴 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `bigkeeper` 工具，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过我们提供的工具，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
+我们借鉴 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `big` 命令，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过 `big` 命令提供的流程，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
 
 ## 应用场景
 
@@ -26,7 +26,9 @@ bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，使用
 - 开发者开发一个 feature 时需要维护多个项目的分支，同时还要频繁修改主项目的 `Podfile`;
 - 项目管理者需要花很大精力去和团队成员同步项目管理规范流程，尤其对于新人，挑战很大；
 - 开发过程中如果碰到突发情况需要开新分支处理问题时对当前工作区的保存操作会很繁琐（PS：因为涉及到多个项目）；
-- 日常开发过程中类似 commit、pull、push 等操作比较繁琐（PS：因为涉及到多个项目）。
+- 日常开发过程中类似 commit、pull、push 等操作比较繁琐（PS：因为涉及到多个项目）；
+- 资源（比如图片）散落在各个业务模块，可能存在重名、重复等问题，难以管理；
+- 业务模块可能存在横向依赖的问题，导致业务模块间耦合严重，不能单独编译运行。
 
 bigkeeper 的出现就是为了解决这些问题。
 
@@ -62,39 +64,43 @@ bigkeeper 的出现就是为了解决这些问题。
 
   ```
   NAME
-      big - Efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.
+    big - Efficiency improvement for iOS&Android module development, iOSer&Android using this tool can make module development easier.
 
   SYNOPSIS
-      big [global options] command [command options] [arguments...]
+    big [global options] command [command options] [arguments...]
 
-  GLOBAL OPTIONS
-      --help         - Show this message
-      -p, --path=arg - (default: ./)
-      -u, --user=arg - (default: mmoaay)
 
-      -v, --ver=arg  - (default: Version in Bigkeeper file)
+  GLOBAL OPTIONS
+    --help         - Show this message
+    -p, --path=arg - (default: ./)
+    -u, --user=arg - (default: mmoaay)
+    -v, --ver=arg  - (default: Version in Bigkeeper file)
 
   COMMANDS
-      feature - Feature operations
-      help    - Shows a list of commands or help for one command
-      hotfix  - Hotfix operations
-      podfile - Podfile operation
-      release - Release operations
-      version - Version
+    feature - Gitflow feature operations
+    help    - Shows a list of commands or help for one command
+    hotfix  - Gitflow hotfix operations
+    image   - Image operations
+    podfile - Podfile operation
+    release - Gitflow release operations
+    spec    - Spec operations
+    version - Show version of bigkeeper
   ```
 
   全局参数如下：
 
   - -p, --path：主项目所在的目录，默认是执行 bigkeeper 命令的当前目录；
-  - -v, --ver：版本号，如果没有指定的话，会以主项目 [Bigkeeper 文件](BIGKEEPER_FILE.md)中指定的版本为准。
+  - -v, --ver：版本号，如果没有指定的话，会以主项目 [Bigkeeper 文件](./docs/zh-CN/BIGKEEPER_FILE.md)中指定的版本为准。
   - -u, --user：用户名，默认是 git global config 的 user.name，会显示在命令提示信息中，比如上述提示信息中的默认用户名是 mmoaay
 
   功能列表如下：
 
   - [feature](./docs/zh-CN/FEATURE&HOTFIX.md)：功能开发流程；
-  - [hotfix](./docs/zh-CN/FEATURE&HOTFIX.md)：线上修复流程；
+  - [hotfix](./docs/zh-CN/FEATURE&HOTFIX.md)：线上 Bug 修复流程；
   - [release](./docs/zh-CN/RELEASE.md)：发布流程；
-  - [podfile](./docs/zh-CN/PODFILE.md)：Podfile 操作流程；
+  - [podfile](./docs/zh-CN/PODFILE.md)：Podfile 管理；
+  - [image](./docs/zh-CN/IMAGE.md)：图片管理；
+  - [spec](./docs/zh-CN/SPEC.md)：spec 管理；
   - version：查看 bigkeeper 当前版本号；
   - help：查看 bigkeeper 帮助文档。
 

data/docs/en-US/README.md

@@ -1,9 +1,13 @@
+
+
 [中文](../zh-CN/README.md)
 
 ---
 
 # bigkeeper - All in home project
 
+![](../../resources/banner.png)
+
 [![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/bigkeeper/maintainability)
 [![Gem Version](https://badge.fury.io/rb/bigkeeper.svg)](https://rubygems.org/gems/bigkeeper)

data/docs/zh-CN/BIGKEEPER_FILE.md

@@ -25,11 +25,33 @@ home 'BigKeeperMain', :git => 'git@github.com:BigKeeper/BigKeeperMain.git', :pul
 - 主项目的 git 远程仓库地址；
 - 主项目的 pull request / merge request 页面地址，完成某个 feature / hotfix 时，会自动打开这个页面，让开发者提交 pull request / merge request。
 
+## 配置模块源
+
+```
+source 'git@git.elenet.me:LPD-iOS/LPDSpecs.git, elenet-lpdspecs' do
+  modules do
+    ...
+  end
+end
+
+source ...
+  ...
+end
+```
+
+考虑到我们的业务模块可能属于不同的源，所以配置业务模块之前，要先在最外层配置源信息：
+
+- 源 git 地址；
+- 源名称。
+
+配置这个主要是方便对我们关心的源执行 `pod repo update`，从而节省命令执行的时间。
+
 ## 配置业务模块
 
 ```
 modules do
   mod 'BigKeeperModular', :git => 'git@github.com:BigKeeper/BigKeeperModular.git', :pulls => 'https://github.com/BigKeeper/BigKeeperModular/pulls'
+  mod ...
 end
 ```
 

data/docs/zh-CN/FEATURE&HOTFIX.md

@@ -52,21 +52,25 @@ COMMANDS
 - delete：根据 featue 名删除主项目和业务模块所有相关分支；（PS：慎用，因为会删除本地和远程所有相关分支）
 - list：显示当前的 feature 列表。
 
-## 各个流程的使用场景
+## 各个指令的使用场景
 
-- 如果需要开发新的功能，使用 bigkeeper feature start；
-- 开发功能过程中如果发现某个模块其实不用改动，使用 bigkeeper feature update 来把这个模块从这个 feature 移除；
-- 使用 bigkeeper feature pull 来同步主项目和相关业务模块远端变更；
-- 使用 bigkeeper feature push 来推送主项目和相关业务模块变更到远端；
-- 使用 bigkeeper feature rebase 来 rebase 主项目和业务模块 `develop` 分支到当前 feature；
-- 使用 bigkeeper feature switch 来切换 feature，比如：两个功能并行开发的时候，就可以用这个命令互相切换了；
-- 功能开发完成，需要单独打包提交测试时，使用 bigkeeper feature finish 结束开发；
-- 开始进行集成测试，需要将代码 PR 到 develop 分支时，使用 bigkeeper feature publish；
-- 如果开发过程中突然有新的功能需要紧急开发，直接使用 bigkeeper feature start 进行新功能开发，旧功能未提交的内容我们会保存在 stash 中。
+- 如果需要开发新的功能，使用 big feature start；
+- 开发功能过程中如果发现某个模块其实不用改动，使用 big feature update 来把这个模块从这个 feature 移除；
+- 使用 big feature pull 来同步主项目和相关业务模块远端变更；
+- 使用 big feature push 来推送主项目和相关业务模块变更到远端；
+- 使用 big feature rebase 来 rebase 主项目和业务模块 `develop` 分支到当前 feature；
+- 使用 big feature switch 来切换 feature，比如：两个功能并行开发的时候，就可以用这个命令互相切换了；
+- 功能开发完成，需要单独打包提交测试时，使用 big feature finish 结束开发；
+- 开始进行集成测试，需要将代码 PR 到 develop 分支时，使用 big feature publish；
+- 如果开发过程中突然有新的功能需要紧急开发，直接使用 big feature start 进行新功能开发，旧功能未提交的内容我们会保存在 stash 中。
 
-## feature 的工作区
+## 各个指令执行结束后工程的状态
 
-![](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.002.jpeg)
+### feature 的工作区
+
+在开始了解各条指令执行后工程的状态之前，我们先了解一下 bigkeeper feature 流程的工作区。
+
+![](../../resources/readme/big-keeper-readme.001.png)
 
 feature 的工作区主要由两部分组成：
 
@@ -79,50 +83,6 @@ feature 的工作区主要由两部分组成：
 - stash 缓存区，当用户需要切换新的 feature 时，对于用户来不及提交的改动，我们会缓存到各个项目的 stash 中，（PS：所以代码突然不见了不要担心，都在 git 的 stash 里面），而当用户切换回某个 feature 时，我们会把和该 feature 分支同名的 stash 恢复回来，从而使用户可以继续开发之前未完成的部分，因为需要通过 feature 的分支名来匹配 stash，而 git stash 又没有提供给 stash 命名的功能，所以我们实现了 [bigstash](https://github.com/BigKeeper/bigstash) 来完成这个功能；
 - git。
 
-## 工作区缓存流程
-
-![stash 当前工作区](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.003.jpeg)
-
-## master／develop 分支状态检查流程
-
-![检查 master／develop 分支状态](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.004.jpeg)
-
-## 切换分支流程
-
-![切换分支](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.005.jpeg)
-
-## 同步业务模块与主项目分支流程
-
-![同步业务模块与主项目分支](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.006.jpeg)
-
-## finish 业务模块 feature／hotfix 流程
-
-![finish 业务模块 feature／hotfix](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.007.jpeg)
-
-## 从 feature／hotfix 移除模块流程
-
-![从 feature／hotfix 移除模块](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.008.jpeg)
-
-## feature start 流程
-
-![start](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.009.jpeg)
-
-## feature finish 流程
-
-![finish](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.010.jpeg)
-
-## feature switch 流程
-
-![switch](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.011.jpeg)
-
-## feature update 流程
-
-![update](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.012.jpeg)
-
-## feature pull 流程
-
-![pull](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.013.jpeg)
-
-## feature push 流程
-
-![push](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.014.jpeg)
+> 注：
+> 1. 所有的指令我们都做了良好的出错提示和异常恢复机制，当某个步骤报错时，只需要根据提示的错误手动修复问题，重新输入指令，bigkeeper 会继续执行接下来的流程。
+> 2. 所有的代码都会保存在工作区中，除了 delete 操作，bigkeeper 不会删除任何工作区的代码，也就是说：你总是可以在变更区、Stash 中或者远端找到你变更的代码。

data/docs/zh-CN/README.md

@@ -4,6 +4,8 @@
 
 # bigkeeper
 
+![](../../resources/banner.png)
+
 [![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
 [![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/big-keeper/maintainability)
 [![Gem Version](https://badge.fury.io/rb/bigkeeper.svg)](https://rubygems.org/gems/bigkeeper)
@@ -11,11 +13,11 @@
 [![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-keeper/blob/master/LICENSE)
 [![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)
 
-bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，使用这个工具后，开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
+bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，旨在帮助有模块化需求的团队更轻松的渡过“半模块化”尴尬期。
 
-> 注：目前只支持依赖 CocoaPods 管理的模块化工程。
+使用这个工具后，开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
 
-我们借鉴 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `bigkeeper` 工具，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过我们提供的工具，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
+我们借鉴 CocoaPods 的做法，开发团队只需要在主项目中加入一个 Bigkeeper 文件，然后利用我们提供的 `big` 命令，即可更便捷的实现**代码分支**和**业务模块**的管理；另外，通过 `big` 命令提供的流程，也能帮助开发者养成更规范的日常开发习惯，减轻项目管理者的负担。
 
 ## 应用场景
 
@@ -24,11 +26,13 @@ bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具，使用
 - 开发者开发一个 feature 时需要维护多个项目的分支，同时还要频繁修改主项目的 `Podfile`;
 - 项目管理者需要花很大精力去和团队成员同步项目管理规范流程，尤其对于新人，挑战很大；
 - 开发过程中如果碰到突发情况需要开新分支处理问题时对当前工作区的保存操作会很繁琐（PS：因为涉及到多个项目）；
-- 日常开发过程中类似 commit、pull、push 等操作比较繁琐（PS：因为涉及到多个项目）。
+- 日常开发过程中类似 commit、pull、push 等操作比较繁琐（PS：因为涉及到多个项目）；
+- 资源（比如图片）散落在各个业务模块，可能存在重名、重复等问题，难以管理；
+- 业务模块可能存在横向依赖的问题，导致业务模块间耦合严重，不能单独编译运行。
 
 bigkeeper 的出现就是为了解决这些问题。
 
-> 注：也有很多人认为直接做一个完整的组件化项目更合理，而不需要采用这样曲折的方案，但是很多时候我们并没有这么多的精力直接去做这些事情，bigkeeper 存在的价值也是为了帮助开发团队在 **iOS&Android 模块化项目过渡阶段**能更轻松的往前走。
+> 注：也有很多人认为直接做一个完整的组件化项目更合理，而不需要采用这样曲折的方案，但是很多时候我们并没有这么多的精力直接去做这些事情，bigkeeper 存在的价值也是为了帮助开发团队在** iOS&Android 模块化项目过渡阶段**能更轻松的往前走。
 
 ## 安装
 
@@ -49,10 +53,6 @@ bigkeeper 的出现就是为了解决这些问题。
 
 ## 使用方法
 
-> 注：每个流程我们都提供详细的流程图来让你了解我们都做了些什么，为了方便你更好的了解我们的流程，我们提供了一个流程参考图，如下：
->
-> ![](../../resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg)
-
 - [Bigkeeper 文件配置](BIGKEEPER_FILE.md)
 - `bigkeeper` 工具使用：
 
@@ -60,25 +60,27 @@ bigkeeper 的出现就是为了解决这些问题。
 
   ```
   NAME
-      big - Efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.
+    big - Efficiency improvement for iOS&Android module development, iOSer&Android using this tool can make module development easier.
 
   SYNOPSIS
-      big [global options] command [command options] [arguments...]
+    big [global options] command [command options] [arguments...]
 
-  GLOBAL OPTIONS
-      --help         - Show this message
-      -p, --path=arg - (default: ./)
-      -u, --user=arg - (default: mmoaay)
 
-      -v, --ver=arg  - (default: Version in Bigkeeper file)
+  GLOBAL OPTIONS
+    --help         - Show this message
+    -p, --path=arg - (default: ./)
+    -u, --user=arg - (default: mmoaay)
+    -v, --ver=arg  - (default: Version in Bigkeeper file)
 
   COMMANDS
-      feature - Feature operations
-      help    - Shows a list of commands or help for one command
-      hotfix  - Hotfix operations
-      podfile - Podfile operation
-      release - Release operations
-      version - Version
+    feature - Gitflow feature operations
+    help    - Shows a list of commands or help for one command
+    hotfix  - Gitflow hotfix operations
+    image   - Image operations
+    podfile - Podfile operation
+    release - Gitflow release operations
+    spec    - Spec operations
+    version - Show version of bigkeeper
   ```
 
   全局参数如下：
@@ -90,9 +92,11 @@ bigkeeper 的出现就是为了解决这些问题。
   功能列表如下：
 
   - [feature](FEATURE&HOTFIX.md)：功能开发流程；
-  - [hotfix](FEATURE&HOTFIX.md)：线上修复流程；
+  - [hotfix](FEATURE&HOTFIX.md)：线上 Bug 修复流程；
   - [release](RELEASE.md)：发布流程；
-  - [podfile](PODFILE.md)：Podfile 操作流程；
+  - [podfile](PODFILE.md)：Podfile 管理；
+  - [image](IMAGE.md)：图片管理；
+  - [spec](SPEC.md)：spec 管理；
   - version：查看 bigkeeper 当前版本号；
   - help：查看 bigkeeper 帮助文档。
 

data/docs/zh-CN/RELEASE.md

@@ -1,43 +1,60 @@
-# release - 功能开发流程
-
-直接在命令行执行 `big release --help` 可以查看其提供的所有功能：
+饿了么物流模块化效率提升思考 -  发布流程篇
+### 背景
+bigkeeper 的目的是为了在项目的模块化过渡阶段提升效率,在过渡到模块化的过程中要做很多的代码抽离,而越来越多的 Pod依赖(假设用Cocoapods做包管理)对项目管理者的负担越来越大.
+移动端完成一个需求迭代,除了代码开发外,还需要有模块发版,集成,打包,回归这些步骤,而往往在回归到发版的时候,研发同学要花较多时间在发版,这严重影响了开发效率.
+### 解决方案
+为了提高要提高发布流程的发布效率,我们开发了big release 功能是来提升发布效率.首先说明,bigkeeper的开发以及发布流程是完全遵循[git-flow 流程](https://jeffkreeftmeijer.com/git-flow/).
+我们建议直接把`Pods`和`Podfile.lock`移出版本控制系统，因为模块化的操作会频繁进行 `Pods`的增删以及更新，但是这会带来版本锁定的困扰,我们建议把版本锁定的工作从 `Podfile.lock`移到`Podfile`中,为此我们做了一个功能 [big pod](---.).
+`bigkeeper`提供了`release module`模块发版和`release home`主工程发版,每种发版方式分为` start`和` finish`, 这两种方式的最大区别是` start`没有`git push`,不会因为可能存在的问题而污染`origin`仓库,这也留一个口子给研发人员进行二次确认.
+#### 模块发版
+在过渡到模块化和已经模块化的项目中, 会存在很多依赖库, 一般会分为:
+* 业务模块库 
+* 业务基础库
+* 二方库(公司内部库)
+* 三方库
+一般来说,二方库和三方库的版本稳定,而每次业务迭代频繁改动往往就是业务模块库与业务基础库,这这两种类型的库在发布的时候往往因为会因为依赖库的原因而导致发版失败,浪费开发人员的时间.
+所以,模块发布提供了两种解决方案:
 ```
-NAME
-    release - Release operations
-
-SYNOPSIS
-    big [global options] release home
-    big [global options] release module
-
-COMMANDS
-    home   - Release home project operations
-    module - Start release module
+big release module finish ExampleModule
+Options:
+    -s, --spec : 模块需要发布版本
 ```
-全局参数如下：
-
-- -u, --user：用户名，默认是 git global config 的 user.name，会显示在命令提示信息中，比如上述提示信息中的默认用户名是 mmoaay
-
-- -p, --path：项目路径名，默认是当前所在的路径
-
-- -v, --version：项目版本号，默认是当前所在的路径
-
-功能列表如下：
-
-- home: 发布主工程命令
-    - start: 开始发布主工程的某个版本
-    - finish: 完成发布版本
-- module: 发布模块命令
-    - start: 开始发布模块的某个版本
-    - finish: 完成发布版本
-
-## release 的工作区
-  同 feature 工作区
+`--spec`指令决定模块需要发版,如果不需要,那仅会在`master`分支打上`tag`.
+而在`start`指令中我们也做了一些安全性检查:
+* 根据开发流程的分支命名规范(branch: feature/x.x.x),检查当前是否有分支还没有合并到`develop`分支;
+* 检查`master`分支相较于`develop`分支是否有超前的` commit`,防止有不规范的操作导致污染` master`分支代码.
+```
+big release module start ExampleModule
+Options:
+    -i, --ignore : 忽略安全性检查(默认开启)
+```
+#### 主工程发版
+在模块化完成之后,主工程基本上是个壳工程,只会有`Podfile`和配置文件的改动, 根据`git-flow`的规则`bigkeeper`在发布主工程时会从`develop`切出` release/x.x.x`分支,`release`分支是一个暂时性分支,在代码已经并入`master`之后会删除`release`分支.
+`release home start`中有两种模块的引用方式:
+```
+pod 'ExampleModule', '0.1.0'
+or
+pod 'ExampleModule', :git => 'ExampleModule.git', :tag => '0.1.0'
+```
+如果模块没有发布,` bigkeeper`会根据在根据仓库里的最新`tag`和`.cocoapods/repos` 里的已发布版本去找到合适的依赖方式.
+在` release home finish`中有一个需要注意的地方就是` release`分支合并到` develop`之前`reset`掉对` Podfile`的操作,这样保持了不会有在` Podfile`文件不会有冲突.
+### 举个例子
+模块发版:
+```
+big -v 0.1.0 release module start ExampleModule
+big -v 0.1.0 release module finish ExampleModule
+Options:
+    -v : 发布是指定版本号,如未指定,则用bigkeeper文件中的vesion
+```
+主工程发版:
+```
+big -v 0.1.0 release home start
+big -v 0.1.0 release home finish
+Options:
+    -v : 发布是指定版本号,如未指定,则用bigkeeper文件中的vesion
+```
+### 展望
+对于很多中大型公司来说都是自己的CI系统,可以把发版本这种耗时而且占内存的工作放在CI机器上,所以我们也有计划把`release module`最后一步的发版本的步骤留个口子,研发同学可以在这里去触发各自CI系统的发版流程.
+### 结束语
+`bigkeeper`在饿了么物流已经实践了半年多了,从数个模块到现在40+的模块数量,仅`release`流程节省项目管理者非常多的时间,提升了效率而且规范化了开发流程,也希望大家在使用中有` issue`反馈给到我们.
 
-## release home start 流程
-![](../../resources/readme/big-keeper-readme.008.png)
-## release home finish 流程
-![](../../resources/readme/big-keeper-readme.009.png)
-## release module  start 流程
-![](../../resources/readme/big-keeper-readme.010.png)
-## release module  finish 流程
-![](../../resources/readme/big-keeper-readme.012.png)

data/docs/zh-CN/SPEC.md

@@ -0,0 +1,39 @@
+# spec - spec 管理
+
+## 背景
+
+模块化推进过程中势必存在业务模块间的横向依赖，原则上这种依赖我们都需要通过 router 进行解耦，不能直接源码依赖其他业务模块，因为这样的依赖会导致如下的问题：
+
+- 因为直接横向依赖业务模块，导致业务模块无法独立编译运行。
+- 各个业务模块如果存在大量类似依赖，必将导致后期模块代码依赖错综复杂，难以维护。
+
+## 功能简介
+
+直接在命令行执行 `big spec --help` 可以查看其提供的所有功能：
+
+```
+NAME
+    spec - Spec operations
+
+SYNOPSIS
+    big [global options] spec [command options] add
+    big [global options] spec [command options] analyze
+    big [global options] spec [command options] delete
+    big [global options] spec [command options] list
+    big [global options] spec [command options] search
+
+COMMAND OPTIONS
+    -a, --[no-]all -
+
+COMMANDS
+    add     - Add a spec (Coming soon).
+    analyze - Analyze spec dependency infomation.
+    delete  - Delete a spec (Coming soon).
+    list    - List all the specs.
+    search  - Search a spec with name (Coming soon).
+```
+
+功能列表如下：
+
+- analyze：分析所有指定模块之间的依赖，通常为业务模块。
+- list：显示当前所有的业务 spec。

data/lib/big_keeper.rb

@@ -11,7 +11,6 @@ require 'big_keeper/model/gitflow_type'
 require 'big_keeper/command/feature&hotfix'
 require 'big_keeper/command/release'
 require 'big_keeper/command/pod'
-require 'big_keeper/command/module'
 require 'big_keeper/command/spec'
 require 'big_keeper/command/image'
 
@@ -47,8 +46,6 @@ module BigKeeper
 
   pod_command
 
-  module_command
-
   spec_command
 
   image_command

data/lib/big_keeper/command/image.rb

@@ -1,26 +1,24 @@
 require 'big_resources/util/image/name_analyze_util'
 
 module BigKeeper
-
   def self.image_command
-
-    desc 'Image operation'
+    desc 'Image operations'
     command :image do | c |
       c.desc "Detect duplicate name images."
-        c.command :name do | name |
-          name.action do | global_options, options, args |
-            path = File.expand_path(global_options[:path])
-            BigResources::ImageAnalyzeUtil.get_duplicate_name_file_with_type(path, BigResources::PNG)
-          end
+      c.command :name do | name |
+        name.action do | global_options, options, args |
+          path = File.expand_path(global_options[:path])
+          BigResources::ImageAnalyzeUtil.get_duplicate_name_file_with_type(path, BigResources::PNG)
         end
+      end
 
-        c.desc "Detect duplicate content images."
-        c.command :content do | content |
-          content.action do | global_options, options, args |
-            path = File.expand_path(global_options[:path])
-            BigResources::ImageAnalyzeUtil.get_duplicate_content_file_with_type(path, BigResources::PNG)
-          end
+      c.desc "Detect duplicate content images."
+      c.command :content do | content |
+        content.action do | global_options, options, args |
+          path = File.expand_path(global_options[:path])
+          BigResources::ImageAnalyzeUtil.get_duplicate_content_file_with_type(path, BigResources::PNG)
         end
+      end
     end
   end
 end

data/lib/big_keeper/command/spec.rb

@@ -1,4 +1,5 @@
 require 'big_keeper/command/spec/analyze'
+require 'big_keeper/command/spec/list'
 require 'big_keeper/command/spec/add'
 require 'big_keeper/command/spec/delete'
 require 'big_keeper/command/spec/search'
@@ -6,10 +7,11 @@ require 'big_keeper/command/spec/search'
 module BigKeeper
 
   def self.spec_command
-    desc 'spec command'
+    desc 'Spec operations'
 
     command :spec do |spec|
       spec.switch [:a,:all]
+      spec.desc 'Analyze spec dependency infomation.'
       spec.command :analyze do |analyze|
         analyze.action do |global_options, options, args|
           path = File.expand_path(global_options[:path])
@@ -18,16 +20,33 @@ module BigKeeper
           spec_analyze(path, is_all, module_names)
         end
       end
+
+      spec.desc 'List all the specs.'
+      spec.command :list do | list |
+        list.action do |global_options, options, args|
+          path = File.expand_path(global_options[:path])
+          version = global_options[:ver]
+          user = global_options[:user].gsub(/[^0-9A-Za-z]/, '').downcase
+
+          spec_list(path, user, options)
+        end
+      end
+
+      spec.desc 'Add a spec (Coming soon).'
       spec.command :add do |add|
         add.action do
           spec_add()
         end
       end
+
+      spec.desc 'Delete a spec (Coming soon).'
       spec.command :delete do |delete|
         delete.action do
           spec_delete()
         end
       end
+
+      spec.desc 'Search a spec with name (Coming soon).'
       spec.command :search do |search|
         search.action do
           spec_search()

data/lib/big_keeper/command/spec/add.rb

@@ -4,6 +4,6 @@ require 'big_keeper/util/logger'
 
 module BigKeeper
   def self.spec_add
-    puts "Hello spec_add"
+    Logger.default('Coming soon.')
   end
 end

data/lib/big_keeper/command/spec/analyze.rb

@@ -10,15 +10,15 @@ module BigKeeper
       Logger.error("parameter conflict: [--all] | [module_names]")
       return
     end
-    puts "start spec analyze..."
-    puts Time.now.to_s
+    Logger.highlight('Start spec analyze...')
+    Logger.default(Time.now.to_s)
 
     # Parse Bigkeeper file
     # BigkeeperParser.parse("#{path}/Bigkeeper")
     # module_names = BigkeeperParser.module_names
 
     # find modules
-    puts "get all modules..."
+    Logger.highlight('Get all modules...')
     module_names = []
     pod_path = path+"/Pods/"
     dir = Dir.open(pod_path)
@@ -28,16 +28,11 @@ module BigKeeper
       end
     end
 
-    is_legal = true
     for input_moudle_name in find_module_names do
       if !module_names.include?(input_moudle_name)
-        is_legal = false
         Logger.error("["+input_moudle_name+"] not exist.")
       end
     end
-    if !is_legal
-      return
-    end
 
     # setup modules
     module_list = []
@@ -54,19 +49,21 @@ module BigKeeper
     end
     # analyze modules spec
 
-    puts "analyze modules "+Time.now.to_s
+    Logger.highlight('Analyze modules...')
+    Logger.default(Time.now.to_s)
     file_index = 0
     for library in module_list do
       if is_all || find_module_names.include?(library.name)
-        puts "analyzing "+library.name
+        Logger.default('Analyzing ' + library.name)
         file_index = file_index + library.file_list.size
         library.spec_dependece_library(module_keyword_map.clone)#(Hash.new(module_keyword_map)).to_hash)
         progress = (file_index*100.0)/file_count
         progress = format("%.02f", progress).to_f
-        puts "progress >>>> "+String(progress)+"% ["+library.name+" done] "
+        Logger.default('progress >>>> ' + String(progress) + '% [' + library.name + ' done] ')
       end
     end
-    puts "analyze complete "+Time.now.to_s
+    Logger.highlight('Analyze complete.')
+    Logger.default(Time.now.to_s)
 
     # log spec info
     for library in module_list do

data/lib/big_keeper/command/spec/delete.rb

@@ -4,6 +4,6 @@ require 'big_keeper/util/logger'
 
 module BigKeeper
   def self.spec_delete
-    puts "Hello spec_delete"
+    Logger.default('Coming soon.')
   end
 end

data/lib/big_keeper/command/{module → spec}/list.rb

@@ -2,7 +2,7 @@ require 'logger'
 require 'json'
 
 module BigKeeper
-  def self.module_list(path, user, options)
+  def self.spec_list(path, user, options)
       BigkeeperParser.parse("#{path}/Bigkeeper")
       module_dic = BigkeeperParser.parse_modules
       module_list = Array.new

data/lib/big_keeper/command/spec/search.rb

@@ -4,6 +4,6 @@ require 'big_keeper/util/logger'
 
 module BigKeeper
   def self.spec_search
-    puts "Hello spec_search"
+    Logger.default('Coming soon.')
   end
 end

data/lib/big_keeper/util/git_operator.rb

@@ -13,7 +13,7 @@ module BigKeeper
       has_branch = false
       IO.popen("cd #{path}; git branch -r") do |io|
         io.each do |line|
-          has_branch = true if line.include? "(#{branch_name})"
+          has_branch = true if line.include? branch_name
         end
       end
       has_branch
@@ -91,7 +91,7 @@ module BigKeeper
       has_commits = false
       IO.popen("cd #{path}; git log --branches --not --remotes") do |io|
         io.each do |line|
-          has_commits = true if line.include? branch_name
+          has_commits = true if line.include? "(#{branch_name})"
         end
       end
       has_commits

data/lib/big_keeper/version.rb

@@ -1,3 +1,3 @@
 module BigKeeper
-  VERSION = "0.8.5"
+  VERSION = "0.8.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigkeeper
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - mmoaay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -247,10 +247,12 @@ files:
 - docs/en-US/README.md
 - docs/zh-CN/BIGKEEPER_FILE.md
 - docs/zh-CN/FEATURE&HOTFIX.md
+- docs/zh-CN/IMAGE.md
 - docs/zh-CN/PODFILE.md
 - docs/zh-CN/README.md
 - docs/zh-CN/RECOMMEND.md
 - docs/zh-CN/RELEASE.md
+- docs/zh-CN/SPEC.md
 - lib/big_keeper.rb
 - lib/big_keeper/command/feature&hotfix.rb
 - lib/big_keeper/command/feature&hotfix/delete.rb
@@ -265,8 +267,6 @@ files:
 - lib/big_keeper/command/feature&hotfix/update.rb
 - lib/big_keeper/command/image.rb
 - lib/big_keeper/command/image/image.rb
-- lib/big_keeper/command/module.rb
-- lib/big_keeper/command/module/list.rb
 - lib/big_keeper/command/pod.rb
 - lib/big_keeper/command/pod/podfile.rb
 - lib/big_keeper/command/release.rb
@@ -276,6 +276,7 @@ files:
 - lib/big_keeper/command/spec/add.rb
 - lib/big_keeper/command/spec/analyze.rb
 - lib/big_keeper/command/spec/delete.rb
+- lib/big_keeper/command/spec/list.rb
 - lib/big_keeper/command/spec/search.rb
 - lib/big_keeper/dependency/dep_gradle_operator.rb
 - lib/big_keeper/dependency/dep_operator.rb
@@ -307,35 +308,11 @@ files:
 - lib/big_keeper/util/xcode_operator.rb
 - lib/big_keeper/version.rb
 - resources/banner.png
+- resources/command.png
 - resources/keynote/big-keeper-readme-example.key
 - resources/keynote/big-keeper-readme-feature.key
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.002.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.003.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.004.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.005.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.006.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.007.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.008.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.009.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.010.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.011.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.012.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.013.jpeg
-- resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.014.jpeg
 - resources/keynote/big-keeper-readme-release.key
 - resources/readme/big-keeper-readme.001.png
-- resources/readme/big-keeper-readme.002.png
-- resources/readme/big-keeper-readme.003.png
-- resources/readme/big-keeper-readme.004.png
-- resources/readme/big-keeper-readme.005.png
-- resources/readme/big-keeper-readme.006.png
-- resources/readme/big-keeper-readme.007.png
-- resources/readme/big-keeper-readme.008.png
-- resources/readme/big-keeper-readme.009.png
-- resources/readme/big-keeper-readme.010.png
-- resources/readme/big-keeper-readme.011.png
-- resources/readme/big-keeper-readme.012.png
 homepage: https://github.com/BigKeeper/bigkeeper
 licenses:
 - MIT

data/lib/big_keeper/command/module.rb

@@ -1,23 +0,0 @@
-require 'big_keeper/command/module/list'
-
-module BigKeeper
-
-  def self.module_command
-
-    desc 'Module operation'
-    command :module do | mod |
-
-      mod.desc 'module'
-      mod.desc 'Prase module relevant infomation.'
-      mod.command :list do | list |
-        list.action do |global_options, options, args|
-          path = File.expand_path(global_options[:path])
-          version = global_options[:ver]
-          user = global_options[:user].gsub(/[^0-9A-Za-z]/, '').downcase
-
-          module_list(path, user, options)
-        end
-      end
-    end
-  end
-end