lapidist 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fc5ae63afead95bedeacb3bfeeea0936bc40bdaacc56349ff35bd4dd55c549a
-  data.tar.gz: ebe06f83cd53b2173fb37a1ec739094cd856e3e07207dafef7fadc622a79864e
+  metadata.gz: 773e9ebed34c07250d220af82f23d30e29d5acc17b53ecda703f6f04aebf23ea
+  data.tar.gz: bbf57e5b58eba1a3750537fb00ed2db56f15876790643237d3fa1b64f2194efd
 SHA512:
-  metadata.gz: b8884c32ef89f516a8411e9496f33dce6de54ae04f6dfd37c1e31f63fe8f8301b8606a6bf6cddfabc90ecda3e2a9d84d352ae4cd6fda9880f297f3ef450f9b12
-  data.tar.gz: d6254f7de0c65f96e651a09df170f15845a509805a56660f9b03c6880c2b8d927461f486cb39bf2726f2e43d130cf9ff0a28aec28759e0c2d1d2546a237f6aed
+  metadata.gz: 409a9acfad520af56fcc6b83b957f59a821183dc623fde09e509fd907a19524c6e218067fe1399ab38f09a529629c7568c561ddc9009849c6033759d785a5059
+  data.tar.gz: 6d48023ce3cebba63b65acd6dd3499e9d5771e034e0794f7f46048d8bf9e62061e6734d28b1d4c56d6212ab4417d8d8e021b86783f9a1573401d5ee1db767a7a

data/README.adoc

@@ -1,33 +1,114 @@
 = Lapidist: synchronized gem releases
 
-TODO.
+== Scope
 
-== Installation
+Certain projects are dependent on the interoperability of a web of gems.
+Changes to dependent gems, especially ones closer to the root, can cause
+many of the downstream gems to need upgrading.
 
-Add this line to your application's Gemfile:
+For example, a release of Metanorma spans over 50 gems. Changes to
+an underlying gem like https://github.com/metanorma/metanorma[`metanorma`]
+will require all downstream gems to re-run all tests.
 
-[source,ruby]
-----
-gem 'lapidist'
-----
+This software is created to simplify the release procedure of dependent
+gems. It provides methods to:
 
-And then execute:
+* Define this dependent web of gems
+* Synchronized gem testing among this dependent web of gems
+* Synchronized release of these gems (with version increments)
 
-[source,sh]
-----
-$ bundle
-----
 
-Or install it yourself as:
+== Terms and definitions
+
+leaf gem:: a gem that is no other software is dependent on
+dependent gem:: a gem that other gems depend on
+root gem:: a gem that does not depend on any other gem in the defined gem web
+gem net:: a coherent set of gems that needs to interoperate and that requires synchronized releasing
+caught gem:: gem under the release control of the releaser
+release repository:: git repository or directory used for the releasing process
+
+== Features
+
+. Integration testing
+** all downstream gems can test against the work-in-progress upstream gems
+** management of `Gemfile` and `gemspec` version control
+
+. Release process
+** automatic version bumps for gems
+** synchronized pushes of feature branches across gems
+** creation of PRs across gems
+** synchronized release of gems
+
+
+== Usage
+
+=== Flow
+
+This is a "`composite-git-flow`" kind of process.
+Maybe it's called `git gush` or `git cascade`.
+
+The typical scenario is:
+
+. A leaf gem needs enhancing
+
+. A leaf gem requires a dependent gem to be updated
+
+. A dependent gem update means the testing on all its downstream gems needs to be updated
+
+This is how the release flow looks like.
+
+
+
+=== Create a repository with all gem sources
+
+For example, the https://github.com/metanorma/metanorma-release[`metanorma-release` repository]
+is a Lapidist-compatible release repository.
+
+It contains the source code for all gems in the Metanorma "`gem net`",
+each separated into its own directory at the root-level.
+
+
+=== Updating code and integrated testing
+
+. Go to the release repository
+
+. Run a command to create feature branches in all gems. (TODO: what is the command?)
+
+. Do the necessary work in the gem source code directory. (e.g. `isodoc` and `metanorma-iso`)
+
+. Run a script that performs tests on all the gems at once using the newly created feature branches (TODO: what is the command?)
+
+.. (alt) if you want Travis to test for you, push the release repository, and Travis will build for you. (assuming the release repository is git managed and/or submoduled, like `metanorma-release`)
+
+. When all the gems pass, run a script to make PRs to every repository. (TODO: what is the command?)
+
+.. If the feature branch for a gem is empty, the script will ignore it.
+
+. Merge PRs by hand or by script (into master or a release branch) (TODO: what is the command?)
+
+
+=== Releasing
+
+. When a release branch is ready (for all gems), run a script to: (TODO: what is the command?)
+.. Bump version of those gems (`VERSION` variable in code)
+.. Update the ``Gemfile``s (remove feature branches)
+.. Update ``gemspec``s to lock versions
+
+. Issue PRs for those gems to merge their release branches into `master`. (TODO: what is the command?)
+
+. Merge the release PRs by hand or by script. (TODO: what is the command?)
+
+Ideally, we want to update the base gems first, then the immediately dependent gems, and so forth to ensure that the builds always pass.
+
+
+
+== Installation
 
 [source,sh]
 ----
 $ gem install lapidist
 ----
 
-== Usage
-
-TODO: Write usage instructions here
 
 == Development
 

data/exe/lapidist

@@ -48,7 +48,7 @@ def common_opts(opts, options)
   end
 end
 
-subcommands = { 
+subcommands = {
   'start' => OptionParser.new do |opts|
     opts.banner = "Usage: ci-master sync [options]"
 
@@ -61,6 +61,7 @@ subcommands = {
       options[:gems] = gems
     end
   end,
+
   'rake' => OptionParser.new do |opts|
     opts.banner = "Usage: ci-master rake [options]"
 
@@ -70,6 +71,7 @@ subcommands = {
       options[:branch] = branch
     end
   end,
+
   'finish' => OptionParser.new do |opts|
     opts.banner = "Usage: ci-master bump [options]"
 
@@ -79,6 +81,7 @@ subcommands = {
       options[:branch] = branch
     end
   end,
+
   'release' => OptionParser.new do |opts|
     opts.banner = "Usage: ci-master do [options]"
 

data/lib/lapidist/cli/command.rb

@@ -1,4 +1,4 @@
-require_relative "../../tool"
+require_relative "../../lapidist"
 
 module Lapidist
   module Cli

data/lib/lapidist/version.rb

@@ -1,3 +1,3 @@
 module Lapidist
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lapidist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose Inc.