devops_helper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de680446ea31db8037dc619b1eef1fad1936a57afdcdd9495cd35a411a61f7a4
-  data.tar.gz: 244a9bb9f7b792a8af1b3ca2df4f7a7b7a111686dac4626306568ef10a01c9b8
+  metadata.gz: 62df2d95274ed5039e7e48c2500cdb3a500beb0a1b7c3fac181e143f35e9ae44
+  data.tar.gz: 31d8db6c498055121b882bffa91c08f6a9d60440a99076a65d140d5fe7bbe481
 SHA512:
-  metadata.gz: d61ba38f0de3919d554e3a036dd773487d89119372ce5d3e0bf612cae2df160d3a21d2df4cef2bee9e4e68c8304111e5aaa6f10f03943aa3b988b395eb64571d
-  data.tar.gz: 5eeb5192dcd6d694bb3a1d7d82fc2a0fa6abb56e2cc72f037c0f9201092452ba46133473d78883db03db9789e306e81f41b0afe6e611f666b842f379fd0a2401
+  metadata.gz: 4940cd9590907cb0b370276c1b634e1ab04ad36e6d13cc538cb88ff10ec38a530681c490f2aa432ddf7f4a8d3d16c09673384d8d6f72051e91a27a73c3fa5e10
+  data.tar.gz: 150797e3d38041a5060de5661289b2c66670be36b7ce422e54512dcd42193061ad82e204e16b1bb7bb558e3a97b5f58e3bc48de1c17da268736b1a274752ab78

data/README.md

@@ -1,8 +1,15 @@
 # DevopsHelper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devops_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
+DevOpsHelper is meant to standardize the workflow, specificially gem release, in simplified and easy to use Rake task.
 
-TODO: Delete this and the text above, and describe your gem
+Basically the typical workflow are:
+1. Check in source code
+2. Edit version.rb
+3. Build the gem
+4. Add to git and tag the release
+5. Push gem file to rubygems
+
+Sure there can have more such as integration with Continous Integration automated test etc. However that's my basic workflow as of now.
 
 ## Installation
 
@@ -20,9 +27,20 @@ Or install it yourself as:
 
     $ gem install devops_helper
 
+This is a set or Rake task haven't found automated way to include into the project Rakefile. Therefore manual intervention is required. 
+
+In order to complete the installation, need to add the following into the project Rakefile
+
+```ruby
+require 'devops_helper'
+```
 ## Usage
 
-TODO: Write usage instructions here
+It runs as typical Rake task:
+
+    $ rake devops:gem_release
+
+Then follow the prompt until it is done.
 
 ## Development
 
@@ -32,7 +50,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devops_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/devops_helper/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devops_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/chrisliaw/devops_helper/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +59,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the DevopsHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/devops_helper/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the DevopsHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/chrisliaw/devops_helper/blob/master/CODE_OF_CONDUCT.md).

data/lib/devops_helper/gem_rake_helper.rb

@@ -14,6 +14,28 @@ module DevopsHelper
       execute_build_task(t)
     end
 
+    def publish_gem(version, opts = { },&block)
+      # find the package
+      root = opts[:root] || Dir.getwd
+      foundGem = Dir.glob("**/*-#{version}.gem")
+      if foundGem.length == 0
+        raise DevopsHelper::Error, "No built gem found."
+      elsif foundGem.length > 1
+        if block
+          targetGem = block.call(:multiple_built_gems, foundGem)
+        else
+          raise DevopsHelper::Error, "Multiple versions of gem found : #{foundGem}. Please provide a block for selection"
+        end
+      else
+        targetGem = foundGem.first
+      end
+
+      cmd = "cd #{root} && gem push #{targetGem}"
+      DevopsHelper::Global.instance.logger.tdebug :gem_rake_helper, "Command to publish gem : #{cmd}"  
+      `#{cmd}`
+      [$?, targetGem]
+    end
+
     private
     def find_build_task
       task = nil

data/lib/devops_helper/tasks/release/gem.rake

@@ -43,6 +43,7 @@ namespace :devops do
     rh = DevopsHelper::GemReleaseHelper.new
     spec = rh.find_gemspec(wd) 
 
+    # find version file
     vf = rh.find_gem_version_file(wd) 
     if vf.length > 1
       # more then one. User has to select
@@ -72,13 +73,14 @@ namespace :devops do
         STDOUT.puts "Gem version file rewritten"
 
         if vh.is_workspace?
-          # commit changes
+          # commit changes of the new version file before tagging
           vh.add(svf)
           vh.commit("Automated commit by DevOps Helper during release process", { files: [svf] })
         end
 
       end
 
+      # tagging start here. Any new changes has to be done before this stage
       if vh.is_workspace?
         begin
           tagSrc = tp.yes?("Tag the source code for this release? ")
@@ -92,14 +94,44 @@ namespace :devops do
           exit(1)
         end
       end
+      # done tagging source code
  
+      # build the gem
       res = rh.build_gem
       STDOUT.puts "Gem '#{gs.name}' built"
+      # gem built
 
       vs.register_version(gs.name, targetVersion)
       vs.save(wd)
       STDOUT.puts "Version '#{targetVersion}' registered"
 
+      # push gem? Optional anyway
+      pub = tp.yes?("Do you want to publish the generated Gem file? ")
+      if pub
+        res, gemFile = rh.publish_gem(targetVersion) do |ops, vers|
+          case ops
+          when :multiple_built_gems
+            sel = vers
+            sel << "Quit"
+            selGem = tp.select("There are multiple Gems with the same version number found. Please select one of the following to publish: ", sel)
+            if selGem == "Quit"
+              STDOUT.puts "No built gem shall be published."
+            else
+              selGem
+            end
+          end
+        end
+
+        if not res.success?
+          STDERR.puts "Failed to publish the Gem."
+        else
+          STDOUT.puts "Gem '#{gemFile}' published"
+        end
+      else
+        STDOUT.puts "Gem will not be published. Please manually publish the gem."
+      end
+      # end push gem
+
     elsif is_empty?(spec)
       STDERR.puts "gemspec file not found at '#{wd}'"
       exit(2)

data/lib/devops_helper/version.rb

@@ -1,3 +1,3 @@
 module DevopsHelper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devops_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-21 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toolrack
@@ -111,7 +111,7 @@ homepage: https://github.com/chrisliaw/devops_helper
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: DevOps Helper to assist in DevOps operation
 test_files: []