git-multirepo 1.0.0.beta77 → 78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91adc8d1ea3a64700628ec1d9cb04040593a6454b4841ecb9b3533db11844ecf
-  data.tar.gz: 21cb5c1d4233514bce14427fcefd4faf77369c153376ca3d4562ead9c1a3e44f
+  metadata.gz: 67bba471cade171734f7f9b6bdf68fc214d77d94117d91c4935d00db73547dde
+  data.tar.gz: 387d7fcd24da4d5d0880687987cd7728919b1dbbadfc2070fc59052a67624eec
 SHA512:
-  metadata.gz: 30bbd2c27a8fbd7b2b35dcbe0003dcc7865330ef5cf4064a0de0d9c8aad317be2c6480b518d2331df0588cb12daddf6b1855544159bd74c1be1450c577210a1e
-  data.tar.gz: 8ee203ef2ac82ef6f7d62ad3afc37c3bcbeeab2622ef6b41b21ad641d2e6b43325cf1f51bdf573cfe628efad416eddc1c70f6ca3049bbfc0ac4135db090f242f
+  metadata.gz: d050eafad731d9f704975b8612364a2569152662fa9df35fea45bba821276435c841cae7f1ea81ea146c6ddd85f423b9ee4c9d78ef018ac844946e778af8c778
+  data.tar.gz: d384043a504f629792474fd179f91a162aa12637d5d4a25d5984f23654607a689c7c7d6f2d42644f6bc54b89882500ac2bb30c140d1d7aa2c3643d893040a530

data/CHANGELOG.md

@@ -1,6 +1,13 @@
-## Releases
+# Releases
 
-To install betas run `gem install git-multirepo --pre`
+## 78.0
+
+The first official release! 🎉
+
+Most kinks have been ironed out by now. There are no major known issues.
+
+- **Enhancement:** Use the (removed) `--exact` flag's behaviour by default for `merge` and `checkout`. To get the old default behaviour (checking out exact commits as stored in the lock file), use `--as-lock`.
+- **Enhancement:** The `merge` command merges without opening an editor by default. Use `--edit` to open an editor for each merge operation as before.
 
 ## 1.0.0.beta77
 

data/README.md

@@ -16,27 +16,27 @@ You can download a handy cheat sheet [here](https://github.com/fortinmike/git-mu
 
 git-multirepo is distributed as a Ruby Gem.
 
-    $ gem install git-multirepo --pre
+    $ gem install git-multirepo
 
 The `--pre` flag is necessary to install beta releases.
 
 ## Development
 
 1. Install dependencies with `bundle install` (install the `bundler` gem beforehand if necessary)
-2. Run `rake install` to build and install the tool locally
+2. Run `rake install` to build and install the tool locally (`sudo` might be required based on how your Ruby was installed)
 3. Run it using the command `multi`
 
 ## Motivation
 
-By now the
+The
 [pitfalls](http://somethingsinistral.net/blog/git-submodules-are-probably-not-the-answer/)
 of git submodules are
 [pretty](https://codingkilledthecat.wordpress.com/2012/04/28/why-your-company-shouldnt-use-git-submodules/)
 [well](http://slopjong.de/2013/06/04/git-why-submodules-are-evil/)
 [known](http://stackoverflow.com/questions/12075809/git-submodules-workflow-issues).
-They work when your dependencies are linearly-evolving third-party libraries that you seldom update but they fall apart when it comes to managing your own, constantly evolving dependencies.
+They work when your dependencies are linearly-evolving third-party libraries that you seldom update but they fall apart when it comes to managing your own, constantly evolving dependencies. To solve this, many tools have been created. Among the most popular is [Lerna](https://lerna.js.org) but that only works for JavaScript projets and requires projects to migrate to a monorepo. `git-multirepo` works with separate repos and is language-agnostic.
 
-Git subtrees are the recommended alternative but have pitfalls of their own:
+Git subtrees are a recommended approach, but they have pitfalls of their own:
 
 - They require verbose and error-prone command-line operations. This can become quite tedious when managing more than one or two dependencies.
 - They change the rules of the game when it comes to merges.
@@ -48,7 +48,7 @@ Etc.
 
 ## Overview
 
-Using git-multirepo, you can manage your main project and its dependencies as completely independent repositories while still maintaining the ability to checkout a previous revision in a single step and have the project build properly.
+Using git-multirepo, you can manage your main project and its dependencies as completely independent repositories while still maintaining the ability to checkout a previous revision (or another branch) in a single step and have the project build properly.
 
 A git-multirepo setup looks like this:
 
@@ -62,9 +62,9 @@ MyAwesomeProject
 In essence:
 
 1. You tell git-multirepo what your dependencies are.
-2. Each time you commit the main repo, git-multirepo tracks what revision of each dependency is required by the project (don't worry, it ensures that you don't forget to commit changes to dependencies beforehand; more on that later).
+2. Each time you commit the main repo, git-multirepo tracks what revision of each dependency is required by the project (and it ensures that you don't forget to commit changes to dependencies beforehand; more on that later).
 3. If you ever want to go back to a previous version of your project, git-multirepo handles checking out the main repo and appropriate revisions of all of its dependencies in a single, seamless operation.
-4. Setting up the project on a new machine is only a single `multi clone` away.
+4. Setting up the project on a new machine is only a single `multi clone` away. Checking out source for continuous integration is similarly easy.
 
 ## Example
 
@@ -106,16 +106,18 @@ If you want to stop using git-multirepo, run `multi uninit`. This will remove al
 - Low possibility of human error (such as forgetting to contribute changes to dependencies back to the appropriate remotes, forgetting to commit dependencies in the proper order, etc.)
 - You're not stuck with git-multirepo. It stores its metadata as [YAML](http://www.yaml.org) in the main repo. You can clone and checkout appropriate revisions of your dependencies by hand without git-multirepo if you need to. The information is there, in human-readable form.
 
-| How It Handles...                |  git-multirepo   | git submodules | git subtrees |
-| -------------------------------- | :--------------: | :------------: | :----------: |
-| Working Copy                     | beside main repo |  in main repo  | in main repo |
-| Constantly Evolving Dependencies |       easy       |      hard      |   passable   |
-| Merging Changes to Dependencies  |       easy       |      hard      |   passable   |
-| Contributing Upstream            |       easy       |      easy      |   passable   |
-| Continuous Integration           |      medium      |     medium     |     easy     |
-| Branch-Based Workflows           |      easy\*      |      hard      |     easy     |
+| How It Handles...                |   git-multirepo    | git submodules | git subtrees |
+| -------------------------------- | :----------------: | :------------: | :----------: |
+| Working Copy                     |  beside main repo  |  in main repo  | in main repo |
+| Constantly Evolving Dependencies |        easy        |      hard      |   passable   |
+| Merging Changes to Dependencies  |        easy        |      hard      |   passable   |
+| Contributing Upstream            |        easy        |      easy      |   passable   |
+| Continuous Integration           | medium<sup>1</sup> |     medium     |     easy     |
+| Branch-Based Workflows           |  easy<sup>2</sup>  |      hard      |     easy     |
 
-(\*) The `multi branch` and `multi merge` commands faciliate branching and merging the main repo and its dependencies as a whole.
+(1) For simplified checkouts, you must install and use `git-multirepo` in your CI pipeline, otherwise you forgo the benefits it provides for CI. See [Continuous Integration](#continuous-integration) for details.
+
+(2) The `multi branch` and `multi merge` commands faciliate branching and merging the main repo and its dependencies as a whole.
 
 ## Limitations
 
@@ -141,10 +143,12 @@ After repositories are initialized this way, git-multirepo handles the rest and
 
 ## Continuous Integration
 
+<a href="#continuous-integration"></a>
+
 git-multirepo supports continuous integration in a couple of ways:
 
 - The `install` command has a special `--ci` flag, which:
-  - Installs exact revisions of dependencies in-place
+  - Installs exact revisions of dependencies in-place (as read from the lock file)
   - Skips local hooks installation
   - Logs additional information that's useful in a CI context
 - The `inspect` command offers plumbing-style output that can be used to inspect repositories to conditionally perform multirepo operations on them afterwards.

data/lib/multirepo/commands/checkout-command.rb

@@ -12,8 +12,8 @@ module MultiRepo
     def self.options
       [
         ['<refname>', 'The main repo tag, branch or commit id to checkout.'],
-        ['[--latest]', 'Checkout the HEAD of each dependency branch (as recorded in the lock file) instead of the exact required commits.'],
-        ['[--exact]', 'Checkout the exact specified ref for each repo, regardless of what\'s stored in the lock file.'],
+        ['[--latest]', 'Checkout the HEAD of each dependency branch (as recorded in the lock file) instead of the exact stored commits.'],
+        ['[--as-lock]', 'Checkout the exact commits for each repo based on the lock file, in detached head state.'],
         ['[--force]', 'Force checkout even if there are uncommmitted changes.']
       ].concat(super)
     end
@@ -21,7 +21,7 @@ module MultiRepo
     def initialize(argv)
       @ref_name = argv.shift_argument
       @checkout_latest = argv.flag?("latest")
-      @checkout_exact = argv.flag?("exact")
+      @checkout_lock = argv.flag?("as-lock")
       @force = argv.flag?("force")
       super
     end
@@ -29,8 +29,8 @@ module MultiRepo
     def validate!
       super
       help! "You must specify a branch or commit id to checkout" unless @ref_name
-      unless Utils.only_one_true?(@checkout_latest, @checkout_exact)
-        help! "You can't provide more than one operation modifier (--latest, --exact, etc.)"
+      unless Utils.only_one_true?(@checkout_latest, @checkout_lock)
+        help! "You can't provide more than one operation modifier (--latest, --as-lock, etc.)"
       end
     end
     
@@ -38,7 +38,7 @@ module MultiRepo
       ensure_in_work_tree
       
       # Find out the checkout mode based on command-line options
-      mode = RevisionSelector.mode_for_args(@checkout_latest, @checkout_exact)
+      mode = RevisionSelector.mode_for_args(@checkout_latest, @checkout_lock)
       
       strategy_name = RevisionSelection.name_for_mode(mode)
       Console.log_step("Checking out #{@ref_name} and its dependencies using the '#{strategy_name}' strategy...")

data/lib/multirepo/commands/merge-command.rb

@@ -28,15 +28,17 @@ module MultiRepo
       [
         ['<refname>', 'The main repo tag, branch or commit id to merge.'],
         ['[--latest]', 'Merge the HEAD of each stored dependency branch instead of the commits recorded in the lock file.'],
-        ['[--exact]', 'Merge the exact specified ref for each repo, regardless of what\'s stored in the lock file.'],
-        ['[--no-ff]', 'Never perform a fast-forward.']
+        ['[--as-lock]', 'Merge the exact specified commits for each repo, as stored in the lock file.'],
+        ['[--edit]', 'Open an editor to edit the commit message for each merge operation.'],
+        ['[--ff]', 'Perform a fast-forward if possible.']
       ].concat(super)
     end
     
     def initialize(argv)
       @ref_name = argv.shift_argument
       @checkout_latest = argv.flag?("latest")
-      @checkout_exact = argv.flag?("exact")
+      @checkout_lock = argv.flag?("as-lock")
+      @edit = argv.flag?("edit")
       @fast_forward = argv.flag?("ff")
       super
     end
@@ -44,8 +46,8 @@ module MultiRepo
     def validate!
       super
       help! "You must specify a ref to merge" unless @ref_name
-      unless Utils.only_one_true?(@checkout_latest, @checkout_exact)
-        help! "You can't provide more than one operation modifier (--latest, --exact, etc.)"
+      unless Utils.only_one_true?(@checkout_latest, @checkout_lock)
+        help! "You can't provide more than one operation modifier (--latest, --as-lock, etc.)"
       end
     end
     
@@ -54,7 +56,7 @@ module MultiRepo
       ensure_multirepo_enabled
       
       # Find out the checkout mode based on command-line options
-      mode = RevisionSelector.mode_for_args(@checkout_latest, @checkout_exact)
+      mode = RevisionSelector.mode_for_args(@checkout_latest, @checkout_lock)
       
       strategy_name = RevisionSelection.name_for_mode(mode)
       Console.log_step("Merging #{@ref_name} with '#{strategy_name}' strategy...")
@@ -212,7 +214,7 @@ module MultiRepo
       success = true
       descriptors.each do |descriptor|
         Console.log_substep("#{descriptor.name} : Merging #{descriptor.their_revision} into #{descriptor.our_revision}...")
-        GitRunner.run_as_system(descriptor.repo.path, "merge #{descriptor.their_revision}#{@fast_forward ? '' : ' --no-ff'}")
+        GitRunner.run_as_system(descriptor.repo.path, "merge #{descriptor.their_revision}#{@edit ? '' : ' --no-edit'}#{@fast_forward ? '' : ' --no-ff'}")
         success &= GitRunner.last_command_succeeded
       end
       

data/lib/multirepo/info.rb

@@ -1,5 +1,5 @@
 module MultiRepo
   NAME = "git-multirepo"
-  VERSION = "1.0.0.beta77"
+  VERSION = "78.0"
   DESCRIPTION = "Track multiple Git repositories side-by-side."
 end

data/lib/multirepo/logic/revision-selector.rb

@@ -2,13 +2,13 @@ require_relative "revision-selection"
 
 module MultiRepo
   class RevisionSelector
-    def self.mode_for_args(checkout_latest, checkout_exact)
+    def self.mode_for_args(checkout_latest, checkout_lock)
       if checkout_latest
         RevisionSelection::LATEST
-      elsif checkout_exact
-        RevisionSelection::EXACT
-      else
+      elsif checkout_lock
         RevisionSelection::AS_LOCK
+      else
+        RevisionSelection::EXACT
       end
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-multirepo
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta77
+  version: '78.0'
 platform: ruby
 authors:
 - Michaël Fortin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,9 +219,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: