revision 1.4.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf646b4e8e2eb07bec9aab1ec7663998a5e3d6585f5b5be560d7b76383fa20b
-  data.tar.gz: 47492a7855c38a50484e44b04e637258b1529e3fd6a437f3fc13e07c8ba83107
+  metadata.gz: d15b43ba3833b4581b97b89a7c5ba40890373b5cc85f1186f5917e9ad5d5fb21
+  data.tar.gz: badf688375adaab009a16f4e03a250cb77725fcc3d140d3b47a38d7e8436a575
 SHA512:
-  metadata.gz: 950eee331752b94d3f2ef712f8f06883d104145169547314eded26556cd41b798be6af1bfdf9011b961751737175b317e19c729991f28b87ff3ed5f3163b8e45
-  data.tar.gz: b25b45f4df9917a0c6064224a0e509ff002249524ce72ad43b5cf81d4d6bdadda07a8cb65e1eda6f075717b81a0b996631ac1ade59c0b031ebdf74c36e73233a
+  metadata.gz: 33dea1ba91f478dc674d9c5b3f23f875b9ca192f9a3efa2a27f2e0e33b39a119ffb367353dd17e7b3ecb4ce17df64747b0edef415ea66eb9a1fe8604fae73378
+  data.tar.gz: 7c386e43dd4f3979462f0e0d4c1ca6ae29409f042d5239f5b1434ba7bb8ef4836d5ca70b0786bf86e0b83a4102191f60f4f23df883341c67a0fcd2b851f4d5d7

data/.gitignore

@@ -13,3 +13,5 @@ Gemfile.lock
 
 README.html
 *.zip
+test-output
+*.md5

data/Gemfile

@@ -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

@@ -1,6 +1,5 @@
 #+TITLE: Revision management gem
 #+AUTHOR: Cormac Cannon
-#+EMAIL: cormac.cannon@neuromoddevices.com
 #+LANGUAGE: en
 
 # Generic properties
@@ -24,250 +23,275 @@
 # or alternatively #+SETUPFILE: theme-readtheorg.setup
 
 * Overview
+This gem automates revision management for source projects. The tool is language agnostic (used for C, ruby, python 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 build artefacts to one or more defined (local or remote) filesystem locations
+- Automatically generates md5sums when archiving or deploying build artefacts
 
-  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
+Hacked 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/nmd/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 md5             # Compute md5sums for current build artefacts
+  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.
-
-    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
-
-    ... or a single inline releasable definition.
-
-    #+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: "#"
-        # 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
+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 ...
+
+#+BEGIN_SRC yaml
+    - :folder: relative/path/to/a/releasable/folder
+#+END_SRC
+
+... or a single inline releasable definition.
+
+#+BEGIN_NOTE
+The lines beginning with '#' are explanatory comments
+#+END_NOTE
+
+#+BEGIN_SRC yaml
+  :releasables
+  - :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
+      :artefacts:
+        # A binary artefact
+        - :src: pkg/revision-<VER>.gem
+          :dest: revision-<VER>.gem
+        # ':dest:' defaults to the string specified for ':src:' if not specified explicitly
+        # md5sums are generated by default for each artefact -- the ':md5:' option allows this to be disabled per-artefact
+        - :src: README.org
+          :md5: false
+#+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
-            :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
+#+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
 
 **** 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
-            :artefacts:
-              - :src: pkg/revision-<VER>.gem
-    #+END_SRC
+#+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
 
 *** 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
+#+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/cli.rb

@@ -4,6 +4,7 @@ require_relative 'releasable'
 require_relative 'info'
 require_relative 'errors'
 require_relative 'version'
+require_relative 'md5'
 
 module Revision
   class CLI < Thor
@@ -105,6 +106,21 @@ module Revision
       select_one.tag
     end
 
+    desc 'md5', 'Compute md5sums for current build artefacts'
+    method_option :file, :aliases => "-f", :type => :string, :default => nil ,:desc => "File to md5sum (defaults to build artefacts defined in yaml)"
+    def md5
+      r = select_one
+      files = options[:file].nil? ?
+                r.artefacts.select { |a| a[:md5]==true }.map { |a| a[:src] } :
+                [options[:file]]
+      raise "No files specified" unless files.length
+      puts "Calculating md5sum for files #{files}"
+      for f in files
+        md5sum = Revision::MD5.from_file(f)
+        puts "#{md5sum}"
+      end
+    end
+
     private
 
     def id_options

data/lib/revision/md5.rb

@@ -0,0 +1,51 @@
+require 'digest'
+
+class Revision::MD5
+
+  READ_CHUNK_KB = 1024
+  FILENAME_EXTENSION = "md5"
+
+  attr_reader :root, :filename
+
+  def self.from_file(filepath, filename: nil)
+    raise "File #{filepath} not found" unless File.exist?(filepath)
+    filename ||= File.basename(filepath)
+    root = File.dirname(filepath)
+    stream = File.open(filepath, 'rb')
+    new(stream, filename, root: root)
+  end
+
+  def initialize(ioreader, filename, root: nil)
+    root ||= Dir.getwd
+    @reader = ioreader
+    @root = root
+    @filename = filename
+  end
+
+  def calc
+    md5 = Digest::MD5.new
+    bytes_per_chunk = READ_CHUNK_KB*1024
+    while chunk = @reader.read(bytes_per_chunk)
+      md5 << chunk
+    end
+    md5.hexdigest
+  end
+
+  def to_s
+    <<~EOT
+    #{calc} #{@filename}
+    EOT
+  end
+
+  def md5filename
+    "#{@filename}.#{FILENAME_EXTENSION}"
+  end
+
+  def write(filepath: nil)
+    filepath ||= File.join(@root, md5filename)
+    filename = File.basename(filepath)
+    File.open(filepath, "w") { |f| f.write "#{calc} #{filename}" }
+    filepath
+  end
+
+end

data/lib/revision/releasable.rb

@@ -68,7 +68,8 @@ module Revision
       # Legacy definition syntax compatibility
       @build_def = config[:build] ? config[:build] : { environment: { variables: {}}, steps: config[:build_steps]}
       @artefacts = config[:artefacts] || []
-      @artefacts.each { |a| a[:dest] ||= a[:src] } unless @artefacts.nil? || @artefacts.empty?
+      @artefacts.each { |a| a[:dest] ||= File.basename(a[:src]) } unless @artefacts.nil? || @artefacts.empty?
+      # @artefacts.each { |a| a[:md5] = true if a[:md5].nil? } unless @artefacts.nil? || @artefacts.empty?
       @config = config
     end
 
@@ -95,7 +96,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 +142,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 +158,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
@@ -183,72 +188,110 @@ module Revision
       "#{@id}_revision_history_v#{@revision}.txt"
     end
 
-    def artefact_map(dest_prefix = '')
-      amap = {}
-      @artefacts.each_with_index do |a, index|
-        src = a[:src].gsub(REVISION_PLACEHOLDER, @revision.to_s)
-        dest = a[:dest].gsub(REVISION_PLACEHOLDER, @revision.to_s)
-        if Gem.win_platform? && !src.end_with?('.exe') && File.exist?(File.join(@root, src + '.exe'))
-          puts "... windows platform -- appending '.exe' (#{src})"
-          src += '.exe'
-          dest += '.exe' unless dest.end_with?('.exe')
-        end
-        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}"
+    def interp_rev(string)
+      string.gsub(REVISION_PLACEHOLDER, @revision.to_s)
+    end
+
+    def normalise_artefact(a)
+      src_norm = interp_rev(a[:src])
+      a_norm = {
+        src: src_norm,
+        dest: a[:dest].nil? ? File.basename(src_norm) : interp_rev(a[:dest]),
+        md5: a[:md5].nil? ? true : a[:md5]
+      }
+      if Gem.win_platform? && !a_norm[:src].end_with?('.exe') && File.exist?(File.join(@root, a_norm[:src] + '.exe'))
+        puts "... windows platform -- appending '.exe' ('#{a_norm[:src]}' -> '#{a_norm[src]}.exe')"
+        a_norm[:src] += '.exe'
+        a_norm[:dest] += '.exe' unless a_norm[:dest].end_with?('.exe')
       end
-      amap
+      a_norm
+    end
+
+    def artefacts
+      @artefacts.map { |a| normalise_artefact(a)}
     end
 
     def archive
       puts "Archiving #{@artefacts.length} build artefacts as #{archive_name}..."
-      puts 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|
-          #TODO: Add directory processing....
-          zipfile.add(dest,src)
+        zip_entries = artefacts
+        zip_entries.each.with_index(1) do |a, idx|
+          puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: <= #{a[:src]}"
+          zipfile.add(a[:dest], a[:src])
+          if a[:md5]
+            md5name = "#{a[:dest]}.md5"
+            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: embedding md5sum (#{md5name})"
+            zipfile.get_output_stream(md5name) { |os| os.write("#{MD5.from_file(a[:src])}")}
+          else
+            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: no md5sum required"
+          end
         end
         puts "... embedding revision history as #{changelog_name} "
         zipfile.get_output_stream(changelog_name) { |os| output_changelog(os)}
       end
+      archive_md5 = MD5.from_file(archive_name)
+      puts "... generating archive md5sum as #{archive_md5.md5filename} "
+      archive_md5.write
 
       if @config.dig(:archive)
         archive_root = File.expand_path(@config[:archive])
         puts "... moving #{archive_name} to #{archive_root}"
         FileUtils.mkdir_p(archive_root)
         FileUtils.mv(archive_name, archive_root)
+        FileUtils.mv(archive_md5.md5filename, archive_root)
       end
     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
+      destinations.each do |d|
+        destination = File.expand_path(d[:dest])
 
-      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)
+        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
+        artefacts.each.with_index(1) do |a, idx|
+          # src, dest = entry
+          src = File.join(@root,a[:src])
+          dest = destination.empty? ? a[:dest] : File.join(destination, a[:dest])
+          puts "... (#{idx}/#{artefacts.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)
+          puts "... writing md5sum for '#{dest}' to '#{MD5.from_file(dest).write}'" if a[:md5]
+        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
+
     end
 
     def package

data/lib/revision/version.rb

@@ -1,10 +1,25 @@
 # Defines the revision ID for the revision gem
 module Revision
-  VERSION = "1.4.1".freeze
+  VERSION = "1.6.0".freeze
 end
 
 # <BEGIN CHANGELOG>
 #
+# Version 1.6.0 (01 Dec 2021)
+# - New feature: Automated MD5sum generation during 'archive' and 'deploy' tasks
+#
+# 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
 #

data/releasables.yaml

@@ -5,6 +5,17 @@
       :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>".freeze)
       :comment_prefix: "#"
     :build_steps:
+      - mkdir -p test-output/2
       - bundle exec rake install
+    #Define 3 build artefacts as test cases for 'deploy' and 'archive' tasks
+    #Expect MD5 file to be generated by default for first entry (where not specified explicitly)
     :artefacts:
       - :src: pkg/revision-<VER>.gem
+      - :src: README.org
+        :md5: false
+      - :src: Rakefile
+        :md5: true
+    #Define two deployment destinations to verify multiple deployments work as intended
+    :deploy:
+      - :dest: ./test-output
+      - :dest: ./test-output/2

data/revision.gemspec

@@ -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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revision
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Cormac Cannon
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2021-12-01 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: []
@@ -118,15 +201,18 @@ files:
 - lib/revision/cli.rb
 - lib/revision/errors.rb
 - lib/revision/info.rb
+- lib/revision/md5.rb
 - lib/revision/releasable.rb
 - lib/revision/string_case.rb
 - 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 +227,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.13
+signing_key:
 specification_version: 4
 summary: Language-agnostic revision management tool
 test_files: []