chore: add release task (#4)

G-Rath · web-flow · commit 98a2370f5a7c · 2023-09-16T08:04:48.000+12:00
diff --git a/Gemfile b/Gemfile
@@ -5,6 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in package_json.gemspec
 gemspec
 
+gem "gem-release"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "< 1.51" # TODO: this version dropped support for Ruby 2.6
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -9,6 +9,7 @@ GEM
     ast (2.4.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    gem-release (2.2.2)
     json (2.6.3)
     parallel (1.23.0)
     parser (3.2.2.3)
@@ -70,6 +71,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  gem-release
   package_json!
   rake (~> 13.0)
   rspec (~> 3.0)
diff --git a/rakelib/create_release.rake b/rakelib/create_release.rake
@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "English"
+require "gem-release"
+
+desc("Releases the gem package using the given version.
+
+  IMPORTANT: the gem version must be in valid rubygem format (no dashes).
+  This task depends on the gem-release ruby gem.
+
+  1st argument: The new version in rubygem format (no dashes). Pass no argument to
+                automatically perform a patch version bump.
+  2nd argument: Perform a dry run by passing 'true' as a second argument.
+
+  Example: `rake create_release[2.1.0,false]`")
+
+task :create_release, %i[gem_version dry_run] do |_t, args|
+  args_hash = args.to_hash
+
+  is_dry_run = Release.object_to_boolean(args_hash[:dry_run])
+  gem_version = args_hash.fetch(:gem_version, "").strip
+  gem_root = Release.gem_root
+
+  Release.update_the_local_project
+  Release.ensure_there_is_nothing_to_commit
+  Release.sh_in_dir(gem_root,
+                    "gem bump --no-commit #{gem_version == "" ? "" : "--version #{gem_version}"}")
+  Release.sh_in_dir(gem_root, "bundle install")
+  Release.sh_in_dir(gem_root, "git commit -am 'Bump version to #{gem_version}'")
+  Release.sh_in_dir(gem_root, "git push")
+
+  # See https://github.com/svenfuchs/gem-release
+  Release.release_the_new_gem_version unless is_dry_run
+end
+
+module Release
+  extend FileUtils
+  class << self
+    def gem_root
+      File.expand_path("..", __dir__)
+    end
+
+    # Executes a string or an array of strings in a shell in the given directory in an unbundled environment
+    def sh_in_dir(dir, *shell_commands)
+      shell_commands.flatten.each { |shell_command| sh "cd #{dir} && #{shell_command.strip}" }
+    end
+
+    def ensure_there_is_nothing_to_commit
+      status = `git status --porcelain`
+
+      return if $CHILD_STATUS.success? && status == ""
+
+      error = if $CHILD_STATUS.success?
+                "You have uncommitted code. Please commit or stash your changes before continuing"
+              else
+                "You do not have Git installed. Please install Git, and commit your changes before continuing"
+              end
+      raise(error)
+    end
+
+    def object_to_boolean(value)
+      [true, "true", "yes", 1, "1", "t"].include?(value.instance_of?(String) ? value.downcase : value)
+    end
+
+    def update_the_local_project
+      puts "Pulling latest commits from remote repository"
+
+      sh_in_dir(gem_root, "git pull --rebase")
+      raise "Failed in pulling latest changes from default remote repository." unless $CHILD_STATUS.success?
+    rescue Errno::ENOENT
+      raise "Ensure you have Git and Bundler installed before continuing."
+    end
+
+    def release_the_new_gem_version
+      puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+      puts "Use the OTP for RubyGems!"
+      puts "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
+
+      sh_in_dir(gem_root, "gem release --push --tag")
+    end
+  end
+end
