bigkeeper 0.7.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +7 -0
  2. data/.github/ISSUE_TEMPLATE.md +20 -0
  3. data/.gitignore +50 -0
  4. data/.travis.yml +17 -0
  5. data/CODE_OF_CONDUCT.md +46 -0
  6. data/CONTRIBUTING.md +70 -0
  7. data/Gemfile +10 -0
  8. data/Gemfile.lock +114 -0
  9. data/LICENSE +21 -0
  10. data/README.md +109 -0
  11. data/Rakefile +2 -0
  12. data/big_keeper.gemspec +47 -0
  13. data/bin/big +14 -0
  14. data/bin/setup +8 -0
  15. data/docs/en-US/FEATURE.md +0 -0
  16. data/docs/en-US/README.md +50 -0
  17. data/docs/zh-CN/BIGKEEPER_FILE.md +62 -0
  18. data/docs/zh-CN/FEATURE&HOTFIX.md +121 -0
  19. data/docs/zh-CN/PODFILE.md +43 -0
  20. data/docs/zh-CN/README.md +107 -0
  21. data/docs/zh-CN/RECOMMEND.md +22 -0
  22. data/docs/zh-CN/RELEASE.md +43 -0
  23. data/lib/big_keeper.rb +295 -0
  24. data/lib/big_keeper/command/feature&hotfix/delete.rb +33 -0
  25. data/lib/big_keeper/command/feature&hotfix/finish.rb +56 -0
  26. data/lib/big_keeper/command/feature&hotfix/pull.rb +24 -0
  27. data/lib/big_keeper/command/feature&hotfix/push.rb +25 -0
  28. data/lib/big_keeper/command/feature&hotfix/rebase.rb +27 -0
  29. data/lib/big_keeper/command/feature&hotfix/start.rb +67 -0
  30. data/lib/big_keeper/command/feature&hotfix/switch.rb +47 -0
  31. data/lib/big_keeper/command/feature&hotfix/update.rb +69 -0
  32. data/lib/big_keeper/command/pod/podfile.rb +69 -0
  33. data/lib/big_keeper/command/release/home.rb +66 -0
  34. data/lib/big_keeper/command/release/module.rb +106 -0
  35. data/lib/big_keeper/model/gitflow_type.rb +31 -0
  36. data/lib/big_keeper/model/operate_type.rb +19 -0
  37. data/lib/big_keeper/model/podfile_model.rb +33 -0
  38. data/lib/big_keeper/model/podfile_type.rb +44 -0
  39. data/lib/big_keeper/service/git_service.rb +186 -0
  40. data/lib/big_keeper/service/module_service.rb +124 -0
  41. data/lib/big_keeper/service/stash_service.rb +45 -0
  42. data/lib/big_keeper/util/bigkeeper_parser.rb +198 -0
  43. data/lib/big_keeper/util/git_operator.rb +142 -0
  44. data/lib/big_keeper/util/gitflow_operator.rb +51 -0
  45. data/lib/big_keeper/util/info_plist_operator.rb +46 -0
  46. data/lib/big_keeper/util/logger.rb +40 -0
  47. data/lib/big_keeper/util/pod_operator.rb +15 -0
  48. data/lib/big_keeper/util/podfile_detector.rb +108 -0
  49. data/lib/big_keeper/util/podfile_module.rb +64 -0
  50. data/lib/big_keeper/util/podfile_operator.rb +166 -0
  51. data/lib/big_keeper/util/xcode_operator.rb +13 -0
  52. data/lib/big_keeper/version.rb +3 -0
  53. data/resources/banner.png +0 -0
  54. data/resources/keynote/big-keeper-readme-example.key +0 -0
  55. data/resources/keynote/big-keeper-readme-feature.key +0 -0
  56. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg +0 -0
  57. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.002.jpeg +0 -0
  58. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.003.jpeg +0 -0
  59. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.004.jpeg +0 -0
  60. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.005.jpeg +0 -0
  61. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.006.jpeg +0 -0
  62. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.007.jpeg +0 -0
  63. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.008.jpeg +0 -0
  64. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.009.jpeg +0 -0
  65. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.010.jpeg +0 -0
  66. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.011.jpeg +0 -0
  67. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.012.jpeg +0 -0
  68. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.013.jpeg +0 -0
  69. data/resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.014.jpeg +0 -0
  70. data/resources/keynote/big-keeper-readme-release.key +0 -0
  71. data/resources/readme/big-keeper-readme.001.png +0 -0
  72. data/resources/readme/big-keeper-readme.002.png +0 -0
  73. data/resources/readme/big-keeper-readme.003.png +0 -0
  74. data/resources/readme/big-keeper-readme.004.png +0 -0
  75. data/resources/readme/big-keeper-readme.005.png +0 -0
  76. data/resources/readme/big-keeper-readme.006.png +0 -0
  77. data/resources/readme/big-keeper-readme.007.png +0 -0
  78. data/resources/readme/big-keeper-readme.008.png +0 -0
  79. data/resources/readme/big-keeper-readme.009.png +0 -0
  80. data/resources/readme/big-keeper-readme.010.png +0 -0
  81. data/resources/readme/big-keeper-readme.011.png +0 -0
  82. data/resources/readme/big-keeper-readme.012.png +0 -0
  83. metadata +311 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ab449225c8909098f55adbcb26c5dfe31039774b
4
+ data.tar.gz: ec0775403a510e08b7265307434ebe58e7429365
5
+ SHA512:
6
+ metadata.gz: 6f2d7e97637f10bafb27feea9ebf9e53828fe7e178f544c37b14246545748d3c5d7e14f78f4c7c2db595c45fe7eac8df80bce49ec3d916e6b1c13a13b810441b
7
+ data.tar.gz: 79e766a7ade9aea1525f705a8d48989b9b638207c2610c8aa2ac62201931b926e92d08e497e330910c2e997b18b83b30dc41fb2d303ea7d8378c0bb18a284057
@@ -0,0 +1,20 @@
1
+ ### Check List
2
+
3
+ Thanks for considering to open an issue. Before you submit your issue, please confirm these boxes are checked.
4
+
5
+ - [ ] I have read the [README.md](https://github.com/BigKeeper/bigkeeper/blob/master/README.md), but there is no information I need.
6
+ - [ ] I have searched in [existing issues](https://github.com/BigKeeper/bigkeeper/issues?utf8=%E2%9C%93&q=is%3Aissue), but did find a same one.
7
+
8
+ ### Issue Description
9
+
10
+ #### Description
11
+
12
+ [Tell us about the issue]
13
+
14
+ #### Reproduce
15
+
16
+ [The steps to reproduce this issue. What are the parameters, where did you put your code, etc.]
17
+
18
+ #### Other Comment
19
+
20
+ [Add anything else here]
@@ -0,0 +1,50 @@
1
+ *.gem
2
+ *.rbc
3
+ /.config
4
+ /coverage/
5
+ /InstalledFiles
6
+ /pkg/
7
+ /spec/reports/
8
+ /spec/examples.txt
9
+ /test/tmp/
10
+ /test/version_tmp/
11
+ /tmp/
12
+
13
+ # Used by dotenv library to load environment variables.
14
+ # .env
15
+
16
+ ## Specific to RubyMotion:
17
+ .dat*
18
+ .repl_history
19
+ build/
20
+ *.bridgesupport
21
+ build-iPhoneOS/
22
+ build-iPhoneSimulator/
23
+
24
+ ## Specific to RubyMotion (use of CocoaPods):
25
+ #
26
+ # We recommend against adding the Pods directory to your .gitignore. However
27
+ # you should judge for yourself, the pros and cons are mentioned at:
28
+ # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
29
+ #
30
+ # vendor/Pods/
31
+
32
+ ## Documentation cache and generated files:
33
+ /.yardoc/
34
+ /_yardoc/
35
+ /doc/
36
+ /rdoc/
37
+
38
+ ## Environment normalization:
39
+ /.bundle/
40
+ /vendor/bundle
41
+ /lib/bundler/man/
42
+
43
+ # for a library or gem, you might want to ignore these files since the code is
44
+ # intended to run in multiple environments; otherwise, check them in:
45
+ # Gemfile.lock
46
+ # .ruby-version
47
+ # .ruby-gemset
48
+
49
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
50
+ .rvmrc
@@ -0,0 +1,17 @@
1
+ language: ruby
2
+
3
+ rvm:
4
+ - 2.3.4
5
+ - 2.2.7
6
+ - 2.1.10
7
+
8
+ before_install:
9
+ - gem update --remote bundler
10
+ - gem update --system
11
+
12
+ sudo: false
13
+
14
+ bundler_args: --without=guard
15
+
16
+ notifications:
17
+ disabled: true
@@ -0,0 +1,46 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ ## Our Standards
8
+
9
+ Examples of behavior that contributes to creating a positive environment include:
10
+
11
+ * Using welcoming and inclusive language
12
+ * Being respectful of differing viewpoints and experiences
13
+ * Gracefully accepting constructive criticism
14
+ * Focusing on what is best for the community
15
+ * Showing empathy towards other community members
16
+
17
+ Examples of unacceptable behavior by participants include:
18
+
19
+ * The use of sexualized language or imagery and unwelcome sexual attention or advances
20
+ * Trolling, insulting/derogatory comments, and personal or political attacks
21
+ * Public or private harassment
22
+ * Publishing others' private information, such as a physical or electronic address, without explicit permission
23
+ * Other conduct which could reasonably be considered inappropriate in a professional setting
24
+
25
+ ## Our Responsibilities
26
+
27
+ Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28
+
29
+ Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30
+
31
+ ## Scope
32
+
33
+ This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34
+
35
+ ## Enforcement
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at mmoaay@sina.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38
+
39
+ Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40
+
41
+ ## Attribution
42
+
43
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44
+
45
+ [homepage]: http://contributor-covenant.org
46
+ [version]: http://contributor-covenant.org/version/1/4/
@@ -0,0 +1,70 @@
1
+ # Contributing Guidelines
2
+
3
+ This document contains information and guidelines about contributing to this project.
4
+ Please read it before you start participating.
5
+
6
+ **Topics**
7
+
8
+ * [Asking Questions](#asking-questions)
9
+ * [Reporting Issues](#reporting-issues)
10
+ * [Developers Certificate of Origin](#developers-certificate-of-origin)
11
+
12
+ ## Asking Questions
13
+
14
+ We don't use GitHub as a support forum.
15
+ For any usage questions that are not specific to the project itself,
16
+ please ask on [Stack Overflow](https://stackoverflow.com) instead.
17
+ By doing so, you'll be more likely to quickly solve your problem,
18
+ and you'll allow anyone else with the same question to find the answer.
19
+ This also allows maintainers to focus on improving the project for others.
20
+
21
+ ## Reporting Issues
22
+
23
+ A great way to contribute to the project
24
+ is to send a detailed issue when you encounter an problem.
25
+ We always appreciate a well-written, thorough bug report.
26
+
27
+ Check that the project issues database
28
+ doesn't already include that problem or suggestion before submitting an issue.
29
+ If you find a match, add a quick "+1" or "I have this problem too."
30
+ Doing this helps prioritize the most common problems and requests.
31
+
32
+ When reporting issues, please include the following:
33
+
34
+ * The version of Xcode you're using
35
+ * The version of iOS or macOS you're targeting
36
+ * The full output of any stack trace or compiler error
37
+ * A code snippet that reproduces the described behavior, if applicable
38
+ * Any other details that would be useful in understanding the problem
39
+
40
+ This information will help us review and fix your issue faster.
41
+
42
+ ## Developer's Certificate of Origin
43
+
44
+ By making a contribution to this project, I certify that:
45
+
46
+ - (a) The contribution was created in whole or in part by me and I
47
+ have the right to submit it under the open source license
48
+ indicated in the file; or
49
+
50
+ - (b) The contribution is based upon previous work that, to the best
51
+ of my knowledge, is covered under an appropriate open source
52
+ license and I have the right under that license to submit that
53
+ work with modifications, whether created in whole or in part
54
+ by me, under the same open source license (unless I am
55
+ permitted to submit under a different license), as indicated
56
+ in the file; or
57
+
58
+ - (c) The contribution was provided directly to me by some other
59
+ person who certified (a), (b) or (c) and I have not modified
60
+ it.
61
+
62
+ - (d) I understand and agree that this project and the contribution
63
+ are public and that a record of the contribution (including all
64
+ personal information I submit with it, including my sign-off) is
65
+ maintained indefinitely and may be redistributed consistent with
66
+ this project or the open source license(s) involved.
67
+
68
+ ---
69
+
70
+ *Some of the ideas and wording for the statements above were based on work by the [Alamofire](https://github.com/Alamofire/Alamofire/blob/master/CONTRIBUTING.md) communities. We commend them for their efforts to facilitate collaboration in their projects.*
data/Gemfile ADDED
@@ -0,0 +1,10 @@
1
+ source "https://gems.ruby-china.org/"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in big_keeper.gemspec
6
+ gemspec
7
+
8
+ group :test do
9
+ gem 'rake'
10
+ end
@@ -0,0 +1,114 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ bigkeeper (0.7.3)
5
+ big_stash (~> 0.1)
6
+ cocoapods
7
+ colorize
8
+ gli (~> 2.16)
9
+ plist
10
+
11
+ GEM
12
+ remote: https://gems.ruby-china.org/
13
+ specs:
14
+ CFPropertyList (2.3.3)
15
+ activesupport (4.2.7.1)
16
+ i18n (~> 0.7)
17
+ json (~> 1.7, >= 1.7.7)
18
+ minitest (~> 5.1)
19
+ thread_safe (~> 0.3, >= 0.3.4)
20
+ tzinfo (~> 1.1)
21
+ ast (2.3.0)
22
+ big_stash (0.6.0)
23
+ gli (~> 2.16)
24
+ claide (1.0.1)
25
+ cocoapods (1.2.1)
26
+ activesupport (>= 4.0.2, < 5)
27
+ claide (>= 1.0.1, < 2.0)
28
+ cocoapods-core (= 1.2.1)
29
+ cocoapods-deintegrate (>= 1.0.1, < 2.0)
30
+ cocoapods-downloader (>= 1.1.3, < 2.0)
31
+ cocoapods-plugins (>= 1.0.0, < 2.0)
32
+ cocoapods-search (>= 1.0.0, < 2.0)
33
+ cocoapods-stats (>= 1.0.0, < 2.0)
34
+ cocoapods-trunk (>= 1.2.0, < 2.0)
35
+ cocoapods-try (>= 1.1.0, < 2.0)
36
+ colored2 (~> 3.1)
37
+ escape (~> 0.0.4)
38
+ fourflusher (~> 2.0.1)
39
+ gh_inspector (~> 1.0)
40
+ molinillo (~> 0.5.7)
41
+ nap (~> 1.0)
42
+ ruby-macho (~> 1.1)
43
+ xcodeproj (>= 1.4.4, < 2.0)
44
+ cocoapods-core (1.2.1)
45
+ activesupport (>= 4.0.2, < 5)
46
+ fuzzy_match (~> 2.0.4)
47
+ nap (~> 1.0)
48
+ cocoapods-deintegrate (1.0.1)
49
+ cocoapods-downloader (1.1.3)
50
+ cocoapods-plugins (1.0.0)
51
+ nap
52
+ cocoapods-search (1.0.0)
53
+ cocoapods-stats (1.0.0)
54
+ cocoapods-trunk (1.2.0)
55
+ nap (>= 0.8, < 2.0)
56
+ netrc (= 0.7.8)
57
+ cocoapods-try (1.1.0)
58
+ colored2 (3.1.2)
59
+ colorize (0.8.1)
60
+ escape (0.0.4)
61
+ fourflusher (2.0.1)
62
+ fuzzy_match (2.0.4)
63
+ gh_inspector (1.0.2)
64
+ gli (2.17.1)
65
+ i18n (0.7.0)
66
+ json (1.8.3)
67
+ minitest (5.8.3)
68
+ molinillo (0.5.7)
69
+ nanaimo (0.2.3)
70
+ nap (1.1.0)
71
+ netrc (0.7.8)
72
+ parallel (1.12.0)
73
+ parser (2.4.0.0)
74
+ ast (~> 2.2)
75
+ plist (3.3.0)
76
+ powerpack (0.1.1)
77
+ rainbow (2.2.2)
78
+ rake
79
+ rake (10.5.0)
80
+ rubocop (0.50.0)
81
+ parallel (~> 1.10)
82
+ parser (>= 2.3.3.1, < 3.0)
83
+ powerpack (~> 0.1)
84
+ rainbow (>= 2.2.2, < 3.0)
85
+ ruby-progressbar (~> 1.7)
86
+ unicode-display_width (~> 1.0, >= 1.0.1)
87
+ ruby-macho (1.1.0)
88
+ ruby-progressbar (1.9.0)
89
+ thread_safe (0.3.5)
90
+ tzinfo (1.2.2)
91
+ thread_safe (~> 0.1)
92
+ unicode-display_width (1.3.0)
93
+ xcodeproj (1.4.4)
94
+ CFPropertyList (~> 2.3.3)
95
+ claide (>= 1.0.1, < 2.0)
96
+ colored2 (~> 3.1)
97
+ nanaimo (~> 0.2.3)
98
+
99
+ PLATFORMS
100
+ ruby
101
+
102
+ DEPENDENCIES
103
+ big_stash (~> 0.1)
104
+ bigkeeper!
105
+ bundler (~> 1.15)
106
+ cocoapods
107
+ colorize
108
+ gli (~> 2.16)
109
+ plist
110
+ rake
111
+ rubocop (~> 0.50.0)
112
+
113
+ BUNDLED WITH
114
+ 1.15.4
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 BigKeeper.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,109 @@
1
+ ![](./resources/banner.png)
2
+
3
+ [English](./docs/en-US/README.md)
4
+
5
+ ---
6
+
7
+ # bigkeeper
8
+
9
+ [![Build Status](https://travis-ci.org/BigKeeper/bigkeeper.svg?branch=master)](https://travis-ci.org/BigKeeper/bigkeeper)
10
+ [![Maintainability](https://api.codeclimate.com/v1/badges/c6dc4161e84fcec9a890/maintainability)](https://codeclimate.com/github/BigKeeper/big-keeper/maintainability)
11
+ [![Gem Version](https://badge.fury.io/rb/bigkeeper.svg)](https://rubygems.org/gems/bigkeeper)
12
+ [![Language: Ruby](https://img.shields.io/badge/language-Ruby-da212f.svg)](https://www.ruby-lang.org/)
13
+ [![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-keeper/blob/master/LICENSE)
14
+ [![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)
15
+
16
+ bigkeeper 是一个 **iOS&Android 模块化项目**效率提升工具,使用这个工具后,开发者**在主项目内**即可完成**包括其他业务模块在内**所有代码的编写和管理。
17
+
18
+ > 注:目前只支持依赖 CocoaPods 管理的模块化工程。
19
+
20
+ 我们借鉴 CocoaPods 的做法,开发团队只需要在主项目中加入一个 Bigkeeper 文件,然后利用我们提供的 `bigkeeper` 工具,即可更便捷的实现**代码分支**和**业务模块**的管理;另外,通过我们提供的工具,也能帮助开发者养成更规范的日常开发习惯,减轻项目管理者的负担。
21
+
22
+ ## 应用场景
23
+
24
+ 在模块化项目的过渡阶段,我们往往会碰到业务拆分不是那么彻底的情况(PS:比如主项目中仍然存在业务相关代码),这样就会导致一系列问题:
25
+
26
+ - 开发者开发一个 feature 时需要维护多个项目的分支,同时还要频繁修改主项目的 `Podfile`;
27
+ - 项目管理者需要花很大精力去和团队成员同步项目管理规范流程,尤其对于新人,挑战很大;
28
+ - 开发过程中如果碰到突发情况需要开新分支处理问题时对当前工作区的保存操作会很繁琐(PS:因为涉及到多个项目);
29
+ - 日常开发过程中类似 commit、pull、push 等操作比较繁琐(PS:因为涉及到多个项目)。
30
+
31
+ bigkeeper 的出现就是为了解决这些问题。
32
+
33
+ > 注:也有很多人认为直接做一个完整的组件化项目更合理,而不需要采用这样曲折的方案,但是很多时候我们并没有这么多的精力直接去做这些事情,bigkeeper 存在的价值也是为了帮助开发团队在** iOS&Android 模块化项目过渡阶段**能更轻松的往前走。
34
+
35
+ ## 安装
36
+
37
+ - 当作 Ruby Gem 使用:
38
+ 在项目的 Gemfile 中加入下面这行:
39
+
40
+ ```ruby
41
+ gem 'bigkeeper'
42
+ ```
43
+
44
+ 然后执行:
45
+
46
+ $ bundle
47
+
48
+ - 直接安装:
49
+
50
+ $ gem install bigkeeper
51
+
52
+ ## 使用方法
53
+
54
+ > 注:每个流程我们都提供详细的流程图来让你了解我们都做了些什么,为了方便你更好的了解我们的流程,我们提供了一个流程参考图,如下:
55
+ >
56
+ > ![](./resources/keynote/big-keeper-readme-feature/big-keeper-readme-feature.001.jpeg)
57
+
58
+ - [Bigkeeper 文件配置](./docs/zh-CN/BIGKEEPER_FILE.md)
59
+ - `bigkeeper` 工具使用:
60
+
61
+ 直接在命令行执行 `bigkeeper` 可以查看其提供的所有功能:
62
+
63
+ ```
64
+ NAME
65
+ big - Efficiency improvement for iOS&Android modular development, iOSer&Android using this tool can make modular development easier.
66
+
67
+ SYNOPSIS
68
+ big [global options] command [command options] [arguments...]
69
+
70
+ GLOBAL OPTIONS
71
+ --help - Show this message
72
+ -p, --path=arg - (default: ./)
73
+ -u, --user=arg - (default: mmoaay)
74
+
75
+ -v, --ver=arg - (default: Version in Bigkeeper file)
76
+
77
+ COMMANDS
78
+ feature - Feature operations
79
+ help - Shows a list of commands or help for one command
80
+ hotfix - Hotfix operations
81
+ podfile - Podfile operation
82
+ release - Release operations
83
+ version - Version
84
+ ```
85
+
86
+ 全局参数如下:
87
+
88
+ - -p, --path:主项目所在的目录,默认是执行 bigkeeper 命令的当前目录;
89
+ - -v, --ver:版本号,如果没有指定的话,会以主项目 [Bigkeeper 文件](BIGKEEPER_FILE.md)中指定的版本为准。
90
+ - -u, --user:用户名,默认是 git global config 的 user.name,会显示在命令提示信息中,比如上述提示信息中的默认用户名是 mmoaay
91
+
92
+ 功能列表如下:
93
+
94
+ - [feature](./docs/zh-CN/FEATURE&HOTFIX.md):功能开发流程;
95
+ - [hotfix](./docs/zh-CN/FEATURE&HOTFIX.md):线上修复流程;
96
+ - [release](./docs/zh-CN/RELEASE.md):发布流程;
97
+ - [podfile](./docs/zh-CN/PODFILE.md):Podfile 操作流程;
98
+ - version:查看 bigkeeper 当前版本号;
99
+ - help:查看 bigkeeper 帮助文档。
100
+
101
+ ## 其他
102
+
103
+ - [一些建议](./docs/zh-CN/RECOMMEND.md)
104
+
105
+ ## 协议
106
+
107
+ ![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)
108
+
109
+ bigkeeper 基于 MIT 协议进行分发和使用,更多信息参见协议文件。