cimas 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75ee4551ad4b87e20cefd3e07d17b35b705c7a1913120b64c6f7025f584889c6
-  data.tar.gz: 0f215697f7ec882570b362295a4bf61a995ba942069933fe115e8db9625f6755
+  metadata.gz: 96ff28c48d78e8043cabfbd44923abe5601563073ced3a64ed421beef5c97be7
+  data.tar.gz: 570e80bff89e510e3057dfc570b7a593a98ad8cf2a6dd3401e716296d2d04ed4
 SHA512:
-  metadata.gz: b0e666111cc035476b234f1727811776966508ebef5c4358350097841aa3dad55ac7e757a6ac19bd9161f396277305a64cd5c5c127466f5d7a97b33722f74239
-  data.tar.gz: 55469b83a7561851172d430451379ab87ff5c467034c1562e513ecbd7f34a47874e9178837c39c6c14c0ac1169ef62134733a5d13ea91074b6a8398a4ad1b222
+  metadata.gz: 195e11ba4eb52f1e38b332131590c3501652d4597f33e957d2632fa3d1194f1421c452da33a02fb34c64611f9793b32db206175d4f9fd100cd690df0033ee77b
+  data.tar.gz: 9cfb9aeaaed12894e646177357227e87491a2069e00eac8b1828119a352d83dc527c306d0000c18a484733e540996048b540b7c4368ef2fa9b301361dd08aa22

data/README.adoc

@@ -1,5 +1,10 @@
 = Cimas ("`Continuous integration master`")
 
+image:https://img.shields.io/gem/v/cimas.svg["Gem Version", link="https://rubygems.org/gems/cimas"]
+image:https://codeclimate.com/github/metanorma/cimas/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/cimas"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/cimas.svg["Pull Requests", link="https://github.com/metanorma/cimas/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/cimas/latest.svg["Commits since latest",link="https://github.com/metanorma/cimas/releases"]
+
 == Purpose
 
 Cimas handles synchronizing CI configuration across multiple repositories.
@@ -43,6 +48,7 @@ gem install cimas
 Or, by specifying it in your `Gemfile` if you're using Bundler.
 
 
+
 == Concepts
 
 CI configuration file:: file to configure CI behavior of a repository
@@ -52,9 +58,36 @@ Cimas working area:: local directory where Cimas works within
 Cimas managed repository:: repository with CI configuration managed by Cimas
 
 
+== Demonstration
+
+The https://github.com/metanorma/metanorma-build-scripts[`metanorma-build-scripts`]
+repository contains Cimas configuration under `cimas-config/`
+for the https://github.com/metanorma[Metanorma] repositories.
+
+* `cimas-config/`: the CI master configuration directory
+* `cimas-config/cimas.yml`: the Cimas configuration file
+
+Have a look to see how it's being used!
+
+
+== Prerequisites
+
+=== Setting up the CI configuration master directory
+
+You need to first create a "`CI configuration master directory`" to
+contain master files for CI configuration.
+It is advisable to store the directory in Git for better version management.
+
+For example, with https://github.com/metanorma[Metanorma] repositories,
+the CI master configuration directory is placed in the
+https://github.com/metanorma/metanorma-build-scripts[`metanorma-build-scripts`]
+repository under `cimas-config/`.
+
+
 
 == Usage
 
+
 === Command line
 
 Cimas works through the `cimas` executable. `cimas` provides the following sub-commands.
@@ -202,10 +235,11 @@ by adding commits and branches.
 
 ==== `cimas open-prs`
 
-The `push` sub-command:
+The `open-prs` sub-command:
 
-* commits the changes made by the `sync` sub-command in a new branch;
-* pushes the new branch to the first Git remote.
+* opens Pull Requests for all the specified repositories of the given branch;
+* creates Pull Request Review Requests for the created Pull Requests (if `reviewers` are set in `cimas.yaml:settings` or via the `-w` option);
+* assigns the created Pull Requests to assignees (if `assignees` are set in `cimas.yaml:settings` or via the `-a` option).
 
 Since this command depends on GitHub privileged functionality,
 you must supply your GitHub Personal Access Token (PAT)
@@ -222,6 +256,8 @@ cimas open-prs -f {cimas-config-file} -r {cimas-working-area} \
 # cimas open-prs -f cimas.yml -r ~/src/cimas-wd \
 #   -b my-new-ci-branch \
 #   -m 'My pull-request message' \
+#   [-w {reviewer1,reviewer2...}] \
+#   [-a {assignee1,assignee2...}] \
 #   [-g {group1,group2,...}]
 ----
 
@@ -411,46 +447,6 @@ groups:
 ----
 
 
-=== Setting up the CI configuration master directory
-
-You need to first create the "`CIM configuration directory`".
-
-Typically you'd create one in Git for better version management.
-
-For example, with https://github.com/metanorma[Metanorma] repositories,
-the CIM configuration directory is placed in the https://github.com/metanorma/metanorma-build-scripts[`metanorma-build-scripts`]
-repository.
-
-
-=== Setting up the local CIM working area
-
-CIM requires a local working area to work with managed repositories,
-using Git's pull and push functionalities.
-
-This only _needs to be done once_ (locally), then you can reuse
-this working area for future CI configuration updates.
-
-// `$mn-root`
-
-You need to create the CIM working area
-
-Checkout all repositories
-
-[source,sh]
-----
-# suppose the CIM working area is called $CIM_CONFIG_WD
-mkdir $CIM_CONFIG_WD
-cd $CIM_CONFIG_WD
-repo init -u $CIM_CONFIG_REPO
-repo sync
-git multi checkout master
-echo 'metanorma-build-scripts' > .multigit_ignore
-git clone https://github.com/metanorma/cimas.git
-cd cimas
-----
-
-
-
 
 == Development
 

data/lib/cimas/cli/command.rb

@@ -108,7 +108,10 @@ module Cimas
         filtered_repo_names.each do |repo_name|
 
           repo = repo_by_name(repo_name)
-          # puts "repo_name #{repo_name} #{repo.inspect}"
+          if repo.nil?
+            puts "[WARNING] #{repo_name} not configured, skipping."
+            next
+          end
 
           branch = repo['branch']
           files = repo['files']
@@ -155,7 +158,10 @@ module Cimas
         filtered_repo_names.each do |repo_name|
 
           repo = repo_by_name(repo_name)
-          # puts "repo_name #{repo_name} #{repo.inspect}"
+          if repo.nil?
+            puts "[WARNING] #{repo_name} not configured, skipping."
+            next
+          end
 
           branch = repo['branch']
           files = repo['files']
@@ -250,6 +256,11 @@ module Cimas
         filtered_repo_names.each do |repo_name|
 
           repo = repo_by_name(repo_name)
+          if repo.nil?
+            puts "[WARNING] #{repo_name} not configured, skipping."
+            next
+          end
+
           branch = repo['branch']
           files = repo['files']
 
@@ -311,6 +322,10 @@ module Cimas
 
         filtered_repo_names.each do |repo_name|
           repo = repo_by_name(repo_name)
+          if repo.nil?
+            puts "[WARNING] #{repo_name} not configured, skipping."
+            next
+          end
 
           repo_dir = File.join(repos_path, repo_name)
           unless File.exist?(repo_dir)
@@ -359,6 +374,10 @@ module Cimas
 
         filtered_repo_names.each do |repo_name|
           repo = repo_by_name(repo_name)
+          if repo.nil?
+            puts "[WARNING] #{repo_name} not configured, skipping."
+            next
+          end
 
           repo_dir = File.join(repos_path, repo_name)
           unless File.exist?(repo_dir)

data/lib/cimas/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cimas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: travis