RubyGems - revision - Versions diffs - 1.4.0 → 1.5.3 - Mend

revision 1.4.0 → 1.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adcdc2d0e9d54552cb574a4abcf0f4c305ee1b4679de002a0a6b237ece5b2844
-  data.tar.gz: f316d48ab9d95456707bd10264d99a082b4d3ebbf0c9b2056723af0df3b6e363
+  metadata.gz: 0aeac36b67440a0670c7b89fc3602ae9bfda2bc43add4f6ac3dbb44c0d2d7a45
+  data.tar.gz: 4fa17d34cd367afafb0afb75343405a793ad2f732364ce36680059907d4b8f92
 SHA512:
-  metadata.gz: 236bea8efec06c900852eef6d30bbe544dc50cc9d5a3e27e68de45847f32cfeada7f1c22ddbcdff3245cc1dda2716ac20b827cf83d67d3fb914c65d339bf6187
-  data.tar.gz: 5a18f6d7d2668214c7b1c71fe4d3d25bfbfa78de9c66c3d722bc2cb85cf5097a85adb168a20e4a59b94ae60943dcbb3625417402d51107bf9d52a14397e60cf8
+  metadata.gz: 231c4a899d91b78bc32e160b382b160df9a3e09f0953b81f16101b981bcb350d0252140e9cf075c5daeba75b91b968e54e2b7d382d3e3c949eb2d0fbcc1d01cd
+  data.tar.gz: 6f63c22ed930a5a3830c89fe2902ff9ec6a9ebb01e79810bfa3690e28f25c3ae6e2f85a16d63c4c9a90a8ff6b681f1c937fd1082830381b4c9166de2f0368522

data/.gitignore CHANGED Viewed

@@ -12,3 +12,4 @@
 Gemfile.lock
 README.html
+*.zip

data/Gemfile CHANGED Viewed

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
-#git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in revision.gemspec
 gemspec

data/README.org CHANGED Viewed

@@ -1,6 +1,5 @@
 #+TITLE: Revision management gem
 #+AUTHOR: Cormac Cannon
-#+EMAIL: cormac.cannon@neuromoddevices.com
 #+LANGUAGE: en
 # Generic properties
@@ -24,250 +23,270 @@
 # or alternatively #+SETUPFILE: theme-readtheorg.setup
 * Overview
+This gem automates revision management for source projects. The tool is language agnostic (used for C, ruby and matlab projects, to date -- though you're probably better off using bundler for ruby projects). It supports per-project configuration using a yaml-format file called =releasables.yaml= located at the project root.
-  This gem automates revision management for source projects. The tool is language agnostic (used for C, ruby and matlab projects, to date -- though you're
-  probably better off using bundler for ruby projects). It supports per-project configuration using a yaml-format file called =releasables.yaml= located at
-  the project root.
+It currently supports the following functionality
+- Manage 3-component revision IDs embedded natively in source file
+- Embeds/updates/extracts changelog in source file header/footer comments
+- Automatically prompts for a changelog entry each time a revision identifier is incremented
+- Optionally commits and tags changes to a git repo after an update to the revision ID
+- Builds and archives projects in zip format (including release notes and arbitrary release artefacts defined
+- Deploys
-  It currently supports the following functionality
-  - Manage 3-component revision IDs embedded natively in source file
-  - Embeds/updates/extracts changelog in source file header/footer comments
-  - Automatically prompts for a changelog entry each time a revision identifier is incremented
-  - Optionally commits and tags changes to a git repo after an update to the revision ID
-  - Builds and archives projects in zip format (including release notes and arbitrary release artefacts defined
-  - Deploys
+Worked on sporadically to allow me to tag, archive and deploy projects in multiple languages in a consistent fashion.
 * Installation
 ** Dependencies
-   Ruby / Rubygems installed
+Ruby / Rubygems installed
 ** From rubygems.org
-   #+BEGIN_SRC sh
-     gem install revision
-   #+END_SRC
+#+BEGIN_SRC sh
+  gem install revision
+#+END_SRC
 ** From source
-   #+BEGIN_SRC sh
-git clone git@git.nmd.ie/lib/
-   #+END_SRC
+#+BEGIN_SRC sh
+  git clone git@github.com:cormacc/revision
+#+END_SRC
 *** Checkout
-    #+BEGIN_SRC sh
-      gem install bundler
-      git clone git@git.nmd.ie:gem/revision
-      cd revision
-    #+END_SRC
+#+BEGIN_SRC sh
+  gem install bundler
+  git clone git@github.com:cormacc/revision
+  cd revision
+#+END_SRC
 *** Install
-    #+BEGIN_SRC sh
-      bundle install
-      bundle exec rake install
-    #+END_SRC
-    #+RESULTS:
-    #+begin_example
-    Using rake 10.5.0
-    Using bundler 1.16.0
-    Using coderay 1.1.2
-    Using diff-lcs 1.3
-    Using git 1.3.0
-    Using method_source 0.9.0
-    Using pry 0.11.3
-    Using rubyzip 1.2.1
-    Using thor 0.19.4
-    Using revision 1.0.0 from source at `.`
-    Using rspec-support 3.7.0
-    Using rspec-core 3.7.0
-    Using rspec-expectations 3.7.0
-    Using rspec-mocks 3.7.0
-    Using rspec 3.7.0
-    Bundle complete! 5 Gemfile dependencies, 15 gems now installed.
-    Use `bundle info [gemname]` to see where a bundled gem is installed.
-    revision 1.0.0 built to pkg/revision-1.0.0.gem.
-    revision (1.0.0) installed.
-    #+end_example
+#+BEGIN_SRC sh
+  bundle install
+  bundle exec rake install
+#+END_SRC
+#+RESULTS:
+#+begin_example
+Using rake 10.5.0
+Using bundler 1.16.0
+Using coderay 1.1.2
+Using diff-lcs 1.3
+Using git 1.3.0
+Using method_source 0.9.0
+Using pry 0.11.3
+Using rubyzip 1.2.1
+Using thor 0.19.4
+Using revision 1.0.0 from source at `.`
+Using rspec-support 3.7.0
+Using rspec-core 3.7.0
+Using rspec-expectations 3.7.0
+Using rspec-mocks 3.7.0
+Using rspec 3.7.0
+Bundle complete! 5 Gemfile dependencies, 15 gems now installed.
+Use `bundle info [gemname]` to see where a bundled gem is installed.
+revision 1.0.0 built to pkg/revision-1.0.0.gem.
+revision (1.0.0) installed.
+#+end_example
 * Usage
 ** Supported Commands
-   Run the executable with no arguments to get usage instructions in your console window...
-   #+BEGIN_SRC sh
-     revision
-   #+END_SRC
-   #+RESULTS:
-   #+begin_example
-   Loading releasable definitions from /home/cormacc/nextcloud/nmd/gem/revision/releasables.yaml ...
-   Commands:
-     revision archive         # Archive releasables
-     revision changelog       # Display change log on stdout
-     revision help [COMMAND]  # Describe available commands or one specific command
-     revision info            # Display info for all defined releasables
-     revision major           # Increment major revision index
-     revision minor           # Increment minor revision index
-     revision patch           # Increment patch revision index
-     revision tag             # Commit the current revision to a local git repo ...
-   Options:
-     [--dryrun], [--no-dryrun]
-     [--id=ID]
-   #+end_example
-   #+BEGIN_NOTE
-   The tool can be run from any subfolder of a project root -- it will traverse the tree until it finds
-   an ancestor containing =releasables.yaml= OR can go no further (in which case it throws an error).
-   #+END_NOTE
+Run the executable with no arguments to get usage instructions in your console window...
+#+BEGIN_SRC sh
+  revision
+#+END_SRC
+#+RESULTS:
+#+begin_example
+Loading releasable definitions from /home/cormacc/dev/gem/revision/releasables.yaml ...
+Commands:
+  revision --version, -v   # print the version
+  revision archive         # Archive releasable(s)
+  revision build           # Build releasable(s)
+  revision changelog       # Display change log on stdout
+  revision deploy          # Deploy releasable(s)
+  revision help [COMMAND]  # Describe available commands or one specific command
+  revision info            # Display info for all defined releasables
+  revision major           # Increment major revision index
+  revision minor           # Increment minor revision index
+  revision package         # Build and archive releasables
+  revision patch           # Increment patch revision index
+  revision tag             # Commit the current revision to a local git repo ...
+Options:
+  [--dryrun], [--no-dryrun]
+  [--id=ID]
+#+end_example
+#+BEGIN_NOTE
+The tool can be run from any subfolder of a project root -- it will traverse the tree until it finds
+an ancestor containing =releasables.yaml= OR can go no further (in which case it throws an error).
+#+END_NOTE
 *** Operating on multiple releasables
-    A single =releasables.yaml= file can define multiple releasables, either implicitly (via inclusion) or explicitly
-    (see [[Configuration]] section below for examples). In this context, the ~info~ and ~archive~ commands
-    will operate on all defined releasables, whereas the remaining commands will require the releasable
-    to be specified using the ~--id=~ option, e.g.
+A single =releasables.yaml= file can define multiple releasables, either implicitly (via inclusion) or explicitly
+(see [[Configuration]] section below for examples). In this context, the ~info~ and ~archive~ commands
+will operate on all defined releasables, whereas the remaining commands will require the releasable
+to be specified using the ~--id=~ option, e.g.
-    #+BEGIN_SRC sh
-      revision minor --id=firmware
-    #+END_SRC
+#+BEGIN_SRC sh
+  revision minor --id=firmware
+#+END_SRC
 ** Configuration
-    YAML syntax is used for the configuration file. The [[Syntax]] and [[Examples]] sections below should provide sufficient
-    introduction to the limit subset of language features required to use this tool, however further info
-    may be found at the following links:
+YAML syntax is used for the configuration file. The [[Syntax]] and [[Examples]] sections below should provide sufficient
+introduction to the limit subset of language features required to use this tool, however further info
+may be found at the following links:
-    - http://docs.ansible.com/ansible/latest/YAMLSyntax.html
-    - http://www.yaml.org/start.html
+- http://docs.ansible.com/ansible/latest/YAMLSyntax.html
+- http://www.yaml.org/start.html
 *** Syntax
-    The =releasables.yaml= file should contain a top level ~:releasables~ node.
-    Under this, you can create a list (or YAML /sequence/) of releasable definitions.
+The =releasables.yaml= file should contain a top level ~:releasables~ node.
+Under this, you can create a list (or YAML /sequence/) of releasable definitions.
-    Each sequence item begins with a ~-~ and contains either a link to a folder containing its own =releasables.yaml=
-    defining one or more releasables ...
+Each sequence item begins with a ~-~ and contains either a link to a folder containing its own =releasables.yaml=
+defining one or more releasables ...
-    #+BEGIN_SRC yaml
-      - :folder: relative/path/to/a/releasable/folder
-    #+END_SRC
+#+BEGIN_SRC yaml
+    - :folder: relative/path/to/a/releasable/folder
+#+END_SRC
-    ... or a single inline releasable definition.
+... or a single inline releasable definition.
-    #+BEGIN_NOTE
-    The lines beginning with '#' are explanatory comments
-    #+END_NOTE
+#+BEGIN_NOTE
+The lines beginning with '#' are explanatory comments
+#+END_NOTE
-    #+BEGIN_SRC yaml
-      - :id: my_releasable
-        :revision:
-          # Source file containing the revision identifier
-          # This will also include changelog entries, embedded as comments
-          :src: lib/revision/version.rb
-          # Regex matching the source revision identifier. Must contain the following named capture groups
-          # - major, minor, patch :: Numeric (uint) sequences representing the three revision ID components
-          # - sep1, sep2 :: the characters separating the revision components
-          # - prefix, postfix :: sufficient syntactic context to match the revision ID uniquely
-          # N.B. this regex matches the version ID from the standard bundler gem skeleton,
-          # e.g. VERSION = "1.1.0"
-          :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
-          # Comment char for the project language -- prefixed to each line of changelog entries
-          # Quotes only necessary here to prevent # being interpreted as the beginning of a YAML comment
-          :comment_prefix: "#"
+#+BEGIN_SRC yaml
+    - :id: my_releasable
+      :revision:
+        # Source file containing the revision identifier
+        # This will also include changelog entries, embedded as comments
+        :src: lib/revision/version.rb
+        # Regex matching the source revision identifier. Must contain the following named capture groups
+        # - major, minor, patch :: Numeric (uint) sequences representing the three revision ID components
+        # - sep1, sep2 :: the characters separating the revision components
+        # - prefix, postfix :: sufficient syntactic context to match the revision ID uniquely
+        # N.B. this regex matches the version ID from the standard bundler gem skeleton,
+        # e.g. VERSION = "1.1.0"
+        :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
+        # Comment char for the project language -- prefixed to each line of changelog entries
+        # Quotes only necessary here to prevent # being interpreted as the beginning of a YAML comment
+        :comment_prefix: "#"
         # Sequence of build steps -- each item should be a valid shell command, prefixed with the YAML sequence item token, '- '
         :build_steps:
           - bundle exec rake install
-        # Sequence defining the files (build artefacts) to package in the release archive.
-        # Each artefact definition must include a :src: key/value pair.
-        # An optional :dest: value may be provided to rename the file during packaging, or just (as in the first entry below)
-        # to flatten the folder structure.
-        # Any <VER> (or <REV>) in the :src: or :dest: placeholders wil be replaced with the current revision ID
-        # The revision archive will also include the revision history extracted as a text file
-        :artefacts:
-          # A binary artefact -- the
-          - :src: pkg/revision-<VER>.gem
-            :dest: revision-<VER>.gem
-          # This document -- the :dest: value defaults to duplicating :src: if not specified
-          - :src: README.org
-    #+END_SRC
+          # Sequence defining the files (build artefacts) to package in the release archive.
+          # Each artefact definition must include a :src: key/value pair.
+          # An optional :dest: value may be provided to rename the file during packaging, or just (as in the first entry below)
+          # to flatten the folder structure.
+          # Any <VER> (or <REV>) in the :src: or :dest: placeholders wil be replaced with the current revision ID
+          # The revision archive will also include the revision history extracted as a text file
+          :artefacts:
+            # A binary artefact -- the
+            - :src: pkg/revision-<VER>.gem
+              :dest: revision-<VER>.gem
+              # This document -- the :dest: value defaults to duplicating :src: if not specified
+              - :src: README.org
+#+END_SRC
 **** TODO (or at least consider) add support for overridable defaults
-     e.g. via a =.releasables= configuration file in the user home dir.
-     Though this would be bad for collaborative development as the config file would live outside source control.
-     Possibly useful to support inclusion of a controlled configuration file instead? Primarily to define
-     a revision regex and comment prefix for a group of related releasables....
+e.g. via a =.releasables= configuration file in the user home dir.
+Though this would be bad for collaborative development as the config file would live outside source control.
+Possibly useful to support inclusion of a controlled configuration file instead? Primarily to define
+a revision regex and comment prefix for a group of related releasables....
 *** Examples
 **** C project
-     #+BEGIN_NOTE
-     The ~:regex:~ and ~:comment_prefix:~ keys are absent in the C example below. This project started life as
-     managing some embedded C projects, and the default values reflect this.
-     #+END_NOTE
-     #+BEGIN_SRC yaml
-        :releasables:
-          - :id: mbt_cd_firmware
-            :revision:
-              :src: src/FirmwareRevision.c
-            :build_steps:
-              - make --jobs=8 -f Makefile CONF=bootloadable
+#+BEGIN_NOTE
+The ~:regex:~ and ~:comment_prefix:~ keys are absent in the C example below. This project started life as
+managing some embedded C projects, and the default values reflect this.
+#+END_NOTE
+#+BEGIN_SRC yaml
+    :releasables:
+      - :id: mbt_cd_firmware
+        :revision:
+          :src: src/FirmwareRevision.c
+          :build_steps:
+            - make --jobs=8 -f Makefile CONF=bootloadable
             :artefacts:
               - :src: dist/bootloadable/production/firmware.production.hex
                 :dest: mbt_cd_firmware_v<REV>.bootloadable.hex
-              - :src: dist/default/production/firmware.production.hex
-                :dest: mbt_cd_firmware_v<REV>.standalone.hex
-     #+END_SRC
+                - :src: dist/default/production/firmware.production.hex
+                  :dest: mbt_cd_firmware_v<REV>.standalone.hex
+#+END_SRC
 **** Ruby project
-    #+BEGIN_SRC yaml
-        :releasables:
-          - :id: revision
-            :revision:
-              :src: lib/revision/version.rb
-              :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
-              :comment_prefix: "#"
-            :build_steps:
-              - bundle exec rake install
+#+BEGIN_SRC yaml
+    :releasables:
+      - :id: revision
+        :revision:
+          :src: lib/revision/version.rb
+          :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
+          :comment_prefix: "#"
+          :build_steps:
+            - bundle exec rake install
             :artefacts:
               - :src: pkg/revision-<VER>.gem
-    #+END_SRC
+#+END_SRC
 *** Heirarchical project
-    Rather than defining the releasable parameters inline, a =releasables.yaml= list entry can contain a (relative or absolute) link to another folder containing it's own =releasables.yaml=.
+Rather than defining the releasable parameters inline, a =releasables.yaml= list entry can contain a (relative or absolute) link to another folder containing it's own =releasables.yaml=.
-    i.e assuming the earlier examples were in folders =examples/c= and =examples/ruby= relative to a common root, a separate =releasables.yaml=
-    at that root could include them as follows...
+i.e assuming the earlier examples were in folders =examples/c= and =examples/ruby= relative to a common root, a separate =releasables.yaml=
+at that root could include them as follows...
-    #+BEGIN_SRC yaml
-        :releasables:
-          - :folder: examples/c
-          - :folder: examples/ruby
-    #+END_SRC
+#+BEGIN_SRC yaml
+    :releasables:
+      - :folder: examples/c
+        - :folder: examples/ruby
+#+END_SRC
 **** TODO consider supporting a higher-level aggregate revision ID
-    #+BEGIN_SRC yaml
-      :revision:
-        :src: release_log.txt
+#+BEGIN_SRC yaml
+    :revision:
+      :src: release_log.txt
       :releasables:
         - :folder: examples/c
-        - :folder: examples/ruby
-    #+END_SRC
+          - :folder: examples/ruby
+#+END_SRC
 * Development
-  After checking out the repo, run =bin/setup= to install dependencies. Then, run =rake spec= to run the tests. You can also run =bin/console= for an interactive prompt that will allow you to experiment.
+** Environment
+After checking out the repo, run =bin/setup= to install dependencies. Then, run =rake spec= to run the tests. You can also run =bin/console= for an interactive prompt that will allow you to experiment.
+** Installation from source
+To install this gem from source on your local machine, run =bundle exec rake install= from the repository root.
+** Incrementing release versions
+You can do this using the gem, by entering one of the following commands at the repository root
+| Command          | Effect                                       |
+|------------------+----------------------------------------------|
+| =revision patch= | Patch version increment, e.g. 1.1.0 -> 1.1.1 |
+| =revision minor= | Patch version increment, e.g. 1.1.1 -> 1.2.0 |
+| =revision major= | Major version increment, e.g. 1.2.0 -> 2.0.0 |
+You'll be prompted to rebuild the gem, commit changes to the git repo and add a revision tag to the commit.
-  To install this gem onto your local machine, run =bundle exec rake install=. To release a new version, update the version number in =version.rb=, and then run =bundle exec rake release=, which will create a git tag for the version, push git commits and tags, and push the =.gem= file to [rubygems.org](https://rubygems.org).
+Alternatively, manually update the version number in =version.rb= and rebuild/install locally using =bundle exec rake install=
+** Deploying to rubygems
+=bundle exec rake release=, will create a git tag for the version (if not, push git commits and tags, and push the =.gem= file to [rubygems.org](https://rubygems.org).
 * Contributing
-  Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/revision.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cormacc/revision.

data/lib/revision/info.rb CHANGED Viewed

@@ -121,7 +121,7 @@ class Revision::Info
   # Prefixes the entry with an empty line, then prefixes each line with comment chars
   # and converts the line entries to a single string
   def format_changelog_entry(entry_lines)
-    entry_lines.unshift('').map { |line| "#{@comment_prefix} #{line}"}.join("\n")
+    entry_lines.unshift('').map { |line| "#{@comment_prefix} #{line}".rstrip()}.join("\n")
   end
   def get_changelog_entry

data/lib/revision/releasable.rb CHANGED Viewed

@@ -95,7 +95,7 @@ module Revision
     def exec_pipeline(type, steps, skip_steps=0)
       exec_steps = steps[skip_steps..-1]
-      puts "{type} :: Executing steps #{skip_steps+1} to #{steps.length}..."
+      puts "#{type} :: Executing steps #{skip_steps+1} to #{steps.length}..."
       Dir.chdir(@root) do
         exec_steps.each_with_index do |step, index|
           step_index = index+1+skip_steps
@@ -141,8 +141,12 @@ module Revision
       "#{@git_tag_prefix}#{revision}"
     end
+    def escape(a_string)
+      a_string.gsub('"',"\\\"")
+    end
     def tag_annotation
-      @revision.last_changelog_entry.join("\n")
+      escape(@revision.last_changelog_entry.join("\n"))
     end
     def commit_message
@@ -153,7 +157,7 @@ module Revision
         commit_lines << "Also..."
         commit_lines += changelog_entry[2..-1]
       end
-      commit_lines.join("\n")
+      escape(commit_lines.join("\n"))
     end
     def tag
@@ -196,22 +200,23 @@ module Revision
         src = File.join(@root,src)
         dest = dest_prefix.empty? ? dest : File.join(dest_prefix, dest)
         amap[src] = dest
-        puts "... (#{index+1}/#{@artefacts.length}) #{src} => #{dest}"
       end
       amap
     end
     def archive
       puts "Archiving #{@artefacts.length} build artefacts as #{archive_name}..."
-      puts artefact_map
+      amap = artefact_map
       if File.exist?(archive_name)
         puts "... deleting existing archive"
         File.delete(archive_name)
       end
       Zip::File.open(archive_name, Zip::File::CREATE) do |zipfile|
-        artefact_map.each do |src, dest|
+        amap.each.with_index(1) do |entry, idx|
+          src, dest = entry
           #TODO: Add directory processing....
-          zipfile.add(dest,src)
+          puts "... (#{idx}/#{amap.length}) #{src} => #{dest}"
+          zipfile.add(dest, src)
         end
         puts "... embedding revision history as #{changelog_name} "
         zipfile.get_output_stream(changelog_name) { |os| output_changelog(os)}
@@ -226,29 +231,58 @@ module Revision
     end
     def deploy(destination='')
-      if destination=='' and @config.dig(:deploy, :dest)
-        destination = @config[:deploy][:dest]
+      destinations = []
+      if not destination.empty?
+        destinations.append({dest: destination})
+      elsif @config.dig(:deploy)
+        if @config[:deploy].kind_of?(Array)
+          destinations.append(*@config[:deploy])
+        else
+          destinations.append(@config[:deploy])
+        end
       end
-      raise Errors::NotSpecified.new(':deploy/:dest') if destination==''
-      destination = File.expand_path(destination)
+      raise Errors::NotSpecified.new(':deploy') if destinations.empty?
-      if @config.dig(:deploy, :pre)
-        exec_pipeline('deploy (pre)', @config[:deploy][:pre])
-      end
+      #... Eliminated global deployment pre/post functions.
+      #... if applicable to all dests, the logic should probably be a build step...
+      # if @config.dig(:deploy, :pre)
+      #   exec_pipeline('deploy (pre)', @config[:deploy][:pre])
+      # end
-      puts "Deploying #{@artefacts.length} build artefacts to #{destination}..."
-      artefact_map(destination).each do |src, dest|
-        if File.exist?(dest)
-          puts "... deleting existing '#{dest}'"
-          FileUtils.rm_rf(dest)
+      destinations.each do |d|
+        destination = File.expand_path(d[:dest])
+        if d.dig(:pre)
+          exec_pipeline('deploy (pre / #{d[:dest]})', d[:pre])
+        end
+        puts "Deploying #{@artefacts.length} build artefacts to #{destination}..."
+        if not File.exist?(destination)
+          puts "... folder not found -> creating ... '#{destination}'"
+          FileUtils.mkdir_p(destination)
+        end
+        amap = artefact_map(destination)
+        amap.each.with_index(1) do |entry, idx|
+          src, dest = entry
+          puts "... (#{idx}/#{amap.length}) #{src} => #{dest}"
+          if File.exist?(dest)
+            puts "... deleting existing '#{dest}' ..."
+            FileUtils.rm_rf(dest)
+          end
+          puts "... deploying '#{src}' -> '#{dest}"
+          FileUtils.cp_r(src,dest)
+        end
+        File.open(File.join(destination,changelog_name),'w') { |f| output_changelog(f)}
+        if d.dig(:post)
+          exec_pipeline('deploy (post / #{d[:dest]})', d[:post])
         end
-        FileUtils.cp_r(src,dest)
-      end
-      File.open(File.join(destination,changelog_name),'w') { |f| output_changelog(f)}
-      if @config.dig(:deploy, :post)
-        exec_pipeline('deploy (post)', @config[:deploy][:post])
       end
+      # if @config.dig(:deploy, :post)
+      #   exec_pipeline('deploy (post)', @config[:deploy][:post])
+      # end
     end
     def package

data/lib/revision/version.rb CHANGED Viewed

@@ -1,107 +1,122 @@
 # Defines the revision ID for the revision gem
 module Revision
-  VERSION = "1.4.0"
+  VERSION = "1.5.3".freeze
 end
 # <BEGIN CHANGELOG>
-#
+#
+# Version 1.5.3 (26 Oct 2021)
+# - Multiple deployment destinations bugfix -- only last destination was being used.
+#
+# Version 1.5.2 (10 Jun 2020)
+# - Uprevving around undeletable git tag
+#
+## Version 1.5.1 (10 Jun 2020)
+# - Escape " and ' in commit message when constructing git command line (' still problematic in some shells)
+#
+# Version 1.5.0 (13 Feb 2020)
+# - Now handles multiple deployment destinations in releasables.yaml
+#
+# Version 1.4.1 (18 Nov 2019)
+# - Updated to strip trailing whitespace after comment char for empty line
+#
 # Version 1.4.0 (10 Jun 2019)
 # - Now allow the definition of one or more 'secondary_revisions', where a revision ID can be updated with or without an embedded changelog
-#
+#
 # Version 1.3.1 (20 May 2019)
 # - Corrected bug when deploying changelog:w
-#
+#
 # Version 1.3.0 (20 May 2019)
 # - Added :archive: (archive root definition)
 # - Added optional :pre: and :post: steps to :deploy: definition
-#
+#
 # Version 1.2.8 (20 May 2019)
 # - Updated Git tag/commit behaviour -- now commit/tag/push by default
 # - Updated deploy to remove existing targets and copy entire directory trees
-#
+#
 # Version 1.2.7 (17 May 2019)
 # - 'deploy' now expands '~' in paths
-#
+#
 # Version 1.2.6 (17 May 2019)
 # - Updated deploy to use default dest from yaml (if specified)
-#
+#
 # Version 1.2.5 (07 Nov 2018)
 # - Added 'deploy' command
-#
+#
 # Version 1.2.4 (05 Sep 2018)
 # - Added commit message and tag details to `revision info`
 # - Minor refactoring
-#
+#
 # Version 1.2.3 (03 Sep 2018)
 # - Tidied up `revision info` output formatting
-#
+#
 # Version 1.2.2 (03 Sep 2018)
 # - Updated CLI to provide version info
-#
+#
 # Version 1.2.1 (03 Sep 2018)
 # - Update to allow releasable without any artefacts
-#
+#
 # Version 1.2.0 (06 Mar 2018)
 # - Build definition improvements (and new yaml structure)
 # - Added platform-agnostic environment variable definition (handles '~' replacement and :/; path separators)
 # - Added platform-agnostic packaging of binaries (i.e. appending .exe for windows when archiving)
-#
+#
 # Version 1.1.10 (16 Feb 2018)
 # - Modified 'archive' command to just archive existing artefact -- i.e. skip build phase
 # - Added 'package' command that builds AND archives
-#
+#
 # Version 1.1.9 (16 Feb 2018)
 # - Fixed bug when adding first changelog entry to file without existing placeholders
 # - Added standalone build command
-#
+#
 # Version 1.1.8 (15 Dec 2017)
 # - Added .yardopts to build documentation
-#
+#
 # Version 1.1.7 (15 Dec 2017)
 # - Corrected push -- was pushing tags without commit
-#
+#
 # Version 1.1.6 (15 Dec 2017)
 # - Added full changelog entry as tag message
 # - Removed ruby-git dependency from gemspec
-#
+#
 # Version 1.1.5 (15 Dec 2017)
 # - Replaced ruby-git library with shell calls, as wasn't handling submodules correctly
-#
+#
 # Version 1.1.4 (14 Dec 2017)
 # - Minor message body reformatting
-#
+#
 # Version 1.1.3 (14 Dec 2017)
 # - Eliminated duplication of version ID in commit message body
-#
+#
 # Version 1.1.2 (14 Dec 2017)
 # - Removed redundant ':: ' from commit message headline
-#
+#
 # Version 1.1.1 (14 Dec 2017)
 # - Added git connection failure handling
 # - Revision commit message now includes first line of changelog entry
 # - Updated configuration syntax for consistency (:revision: :file: -> :revision: :src:)
-#
+#
 # Version 1.1.0 (13 Dec 2017)
 # - Updated to optionally push tags to the repo
-#
+#
 # Version 1.0.1 (13 Dec 2017)
 # - Corrected revision placeholder handling when archiving build artefacts
 # - Added proper high-level usage documentation
-#
+#
 # Version 1.0.0 (12 Dec 2017)
 # - First fully functional release with new config file
-#
+#
 # Version 0.1.4 (12 Dec 2017)
 # - boo
 # - hoo
 # - hoo
-#
+#
 # Version 0.1.3 (12 Dec 2017)
 # - boo
-#
+#
 # Version 0.1.2 (12 Dec 2017)
 # - wahoo!
-#
+#
 # Version 0.1.1 (12 Dec 2017)
 # - Wahey!
-# <END CHANGELOG>
+# <END CHANGELOG>

data/releasables.yaml CHANGED Viewed

@@ -2,7 +2,7 @@
   - :id: revision
     :revision:
       :src: lib/revision/version.rb
-      :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
+      :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>".freeze)
       :comment_prefix: "#"
     :build_steps:
       - bundle exec rake install

data/revision.gemspec CHANGED Viewed

@@ -6,20 +6,12 @@ Gem::Specification.new do |spec|
   spec.name          = "revision"
   spec.version       = Revision::VERSION
   spec.authors       = ["Cormac Cannon"]
-  spec.email         = ["cormac.cannon@neuromoddevices.com"]
+  spec.licenses      = ['MIT']
   spec.summary       = %q{Language-agnostic revision management tool}
   spec.description   = %q{Updates project revision identifiers in software source files and associated change log. Can also build and package project archives as a zip and optionally commit, tag and push to a Git repo.}
-#  spec.homepage      = "TBC"
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata["allowed_push_host"] = "http://gems.nmd.ie"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
+  spec.homepage    = 'https://rubygems.org/gems/revision'
+  spec.metadata    = { "source_code_uri" => "https://github.com/cormacc/revision" }
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -29,11 +21,22 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
-  spec.add_runtime_dependency 'thor', '~> 0.19.1'
-  spec.add_runtime_dependency 'rubyzip'
+  spec.add_runtime_dependency 'thor', '~> 1.0'
+  spec.add_runtime_dependency 'rubyzip', '~> 2.0'
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
+  #emacs ruby layer deps...
+  #...lsp backend
+  spec.add_development_dependency "steep"
+  spec.add_development_dependency "solargraph"
+  #...robe backend
+  #....watch this space
+  #...generic
+  spec.add_development_dependency "ruby_parser"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "prettier"
+  spec.add_development_dependency "seeing_is_believing"
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revision
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.3
 platform: ruby
 authors:
 - Cormac Cannon
-autorequire:
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,11 +94,94 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: seeing_is_believing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Updates project revision identifiers in software source files and associated
   change log. Can also build and package project archives as a zip and optionally
   commit, tag and push to a Git repo.
 email:
-- cormac.cannon@neuromoddevices.com
 executables:
 - revision
 extensions: []
@@ -123,10 +206,12 @@ files:
 - lib/revision/version.rb
 - releasables.yaml
 - revision.gemspec
-homepage:
-licenses: []
-metadata: {}
-post_install_message:
+homepage: https://rubygems.org/gems/revision
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/cormacc/revision
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.2.13
+signing_key:
 specification_version: 4
 summary: Language-agnostic revision management tool
 test_files: []