chore: Provide a release retry script

Author: dazuma

.github/workflows/ci.yml

@@ -81,7 +81,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Install tools
-        run: gem install --no-document bundler:2.1.4 toys:0.11.2
+        run: gem install --no-document bundler:2.1.4 toys:0.11.4
       - name: Run tests
         env:
           TEST_KAFKA_HOST: kafka

.github/workflows/release-retry.yml

@@ -0,0 +1,38 @@
+name: Retry release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_pr:
+        description: Release PR number
+        required: true
+      flags:
+        description: Extra flags to pass to the release script
+        required: false
+        default: ""
+
+jobs:
+  release-retry:
+    if: ${{ github.repository == 'open-telemetry/opentelemetry-ruby' }}
+    env:
+      ruby_version: "2.7"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Ruby ${{ env.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.ruby_version }}
+      - name: Checkout repo
+        uses: actions/checkout@v2
+      - name: Install Toys
+        run: "gem install --no-document toys"
+      - name: Retry release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          toys release retry --yes --verbose \
+            "--enable-releases=${{ secrets.ENABLE_RELEASES }}" \
+            "--rubygems-api-key=${{ secrets.RUBYGEMS_API_KEY }}" \
+            ${{ github.event.inputs.flags }} \
+            "${{ github.event.inputs.release_pr }}" \
+            < /dev/null

.toys/release/.data/templates/release-retry.yml.erb

@@ -0,0 +1,38 @@
+name: Retry release
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_pr:
+        description: Release PR number
+        required: true
+      flags:
+        description: Extra flags to pass to the release script
+        required: false
+        default: ""
+
+jobs:
+  release-retry:
+    if: ${{ github.repository == '<%= @settings.repo_path %>' }}
+    env:
+      ruby_version: "2.7"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Ruby ${{ env.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.ruby_version }}
+      - name: Checkout repo
+        uses: actions/checkout@v2
+      - name: Install Toys
+        run: "gem install --no-document toys"
+      - name: Retry release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          toys release retry --yes --verbose \
+            "--enable-releases=${{ secrets.ENABLE_RELEASES }}" \
+            "--rubygems-api-key=${{ secrets.RUBYGEMS_API_KEY }}" \
+            ${{ github.event.inputs.flags }} \
+            "${{ github.event.inputs.release_pr }}" \
+            < /dev/null

.toys/release/.lib/release_performer.rb

@@ -56,6 +56,10 @@ def perform_steps
       @parent.initial_setup
       verify unless @parent.skip_checks?
 
+      check_release_exists
+      check_gem_exists
+      check_docs_exists
+
       build_gem if @include_gem
       if @include_docs
         build_docs
@@ -67,6 +71,42 @@ def perform_steps
       push_docs if @include_docs
     end
 
+    def check_gem_exists
+      return if !@parent.check_exists? || !@include_gem
+      result = @utils.capture(["gem", "info", "-r", "-a", @gem_name])
+      if result =~ /#{@gem_name} \(([\w\., ]+)\)/
+        if Regexp.last_match[1].split(/,\s+/).include?(@gem_version)
+          @utils.logger.warn("Gem already pushed for #{@gem_name} #{@gem_version}. Skipping.")
+          @include_gem = false
+        end
+      end
+    end
+
+    def check_docs_exists
+      return if !@parent.check_exists? || !@include_docs
+      base_path = ::File.expand_path(@utils.gem_info(@gem_name, "gh_pages_directory"),
+                                     @parent.gh_pages_dir)
+      versioned_path = ::File.expand_path("v#{@gem_version}", base_path)
+      if File.directory?(versioned_path)
+        @utils.logger.warn("Docs already pushed for #{@gem_name} #{@gem_version}. Skipping.")
+        @include_docs = false
+      end
+    end
+
+    def check_release_exists
+      return if !@parent.check_exists? || !@include_github_release
+      result = @utils.exec(["gh", "api",
+                            "repos/#{@utils.repo_path}/releases/tags/#{@gem_name}/v#{@gem_version}",
+                            "-H", "Accept: application/vnd.github.v3+json"],
+                           out: :null, e: false)
+      if result.success?
+        @utils.logger.warn(
+          "GitHub release already exists for #{@gem_name} #{@gem_version}. Skipping."
+        )
+        @include_github_release = false
+      end
+    end
+
     def verify
       @utils.error("Gem #{@gem_name} not known.") unless @utils.gem_info(@gem_name)
       @utils.verify_library_version(@gem_name, @gem_version)
@@ -79,7 +119,7 @@ def create_github_release(content = nil)
       body = ::JSON.dump(tag_name: "#{@gem_name}/v#{@gem_version}",
                          target_commitish: @parent.release_sha,
                          name: "#{@gem_name} #{@gem_version}",
-                         body: content.strip)
+                         body: content.to_s.strip)
       @utils.exec(["gh", "api", "repos/#{@utils.repo_path}/releases", "--input", "-",
                    "-H", "Accept: application/vnd.github.v3+json"],
                   in: [:string, body], out: :null)
@@ -167,13 +207,15 @@ def initialize(utils,
                  gh_pages_dir: nil,
                  gh_token: nil,
                  pr_info: nil,
+                 check_exists: false,
                  dry_run: false)
     @utils = utils
     @release_sha = @utils.current_sha release_sha
     @skip_checks = skip_checks
     @rubygems_api_key = rubygems_api_key
     @git_remote = git_remote || "origin"
     @dry_run = dry_run
+    @check_exists = check_exists
     @gh_pages_dir = gh_pages_dir
     @gh_token = gh_token
     @pr_info = pr_info
@@ -200,6 +242,10 @@ def skip_checks?
     @skip_checks
   end
 
+  def check_exists?
+    @check_exists
+  end
+
   def add_extra_errors(*messages)
     @extra_errors.concat(messages)
   end

.toys/release/.lib/release_utils.rb

@@ -77,6 +77,12 @@ def capture(cmd, **opts, &block)
     tool_context.capture(cmd, **opts, &block)
   end
 
+  def capture_ruby(code, **opts, &block)
+    opts[:in] = [:string, code]
+    opts = modify_exec_opts(opts, "ruby")
+    tool_context.capture_ruby([], **opts, &block)
+  end
+
   def ensure_gh_binary
     result = exec(["gh", "--version"], out: :capture, exit_on_nonzero_status: false)
     match = /^gh version (\d+)\.(\d+)\.(\d+)/.match(result.captured_out.to_s)
@@ -184,14 +190,17 @@ def add_pr_message(pr_number, message)
     self
   end
 
-  def current_library_version(gem_name)
-    path = gem_version_rb_path(gem_name, from: :absolute)
-    require path
-    const = ::Object
-    gem_version_constant(gem_name).each do |name|
-      const = const.const_get(name)
-    end
-    const
+  def current_library_version(gem_name, at: nil)
+    content =
+      if at
+        path = gem_version_rb_path(gem_name, from: :context)
+        capture(["git", "show", "#{at}:#{path}"])
+      else
+        File.read(gem_version_rb_path(gem_name, from: :absolute))
+      end
+    const = gem_version_constant(gem_name).join("::")
+    content += "\nputs ::#{const}\n"
+    capture_ruby(content).strip
   end
 
   def verify_library_version(gem_name, gem_vers)
@@ -331,6 +340,10 @@ def git_set_user_info
     self
   end
 
+  def released_gems_and_versions(pr_info)
+    single_released_gem_and_version(pr_info) || multiple_released_gems_and_versions(pr_info)
+  end
+
   def log(message)
     logger.info(message)
   end
@@ -397,4 +410,32 @@ def wait_github_checks_internal(ref, deadline)
       interval += 10 unless interval >= 60
     end
   end
+
+  def single_released_gem_and_version(pr_info)
+    gem_name =
+      if all_gems.size == 1
+        default_gem
+      else
+        gem_name_from_release_branch(pr_info["head"]["ref"])
+      end
+    return nil unless gem_name
+    merge_sha = pr_info["merge_commit_sha"]
+    gem_version = current_library_version(gem_name, at: merge_sha)
+    logger.info("Found single gem to release: #{gem_name} #{gem_version}.")
+    { gem_name => gem_version }
+  end
+
+  def multiple_released_gems_and_versions(pr_info)
+    merge_sha = pr_info["merge_commit_sha"]
+    output = capture(["git", "diff", "--name-only", "#{merge_sha}^..#{merge_sha}"])
+    files = output.split("\n")
+    gems = all_gems.find_all do |gem_name|
+      dir = gem_directory(gem_name)
+      files.any? { |file| file.start_with?(dir) }
+    end
+    gems.each_with_object({}) do |gem_name, result|
+      result[gem_name] = gem_version = current_library_version(gem_name, at: merge_sha)
+      logger.info("Releasing gem due to file changes: #{gem_name} #{gem_version}.")
+    end
+  end
 end

.toys/release/.lib/repo_settings.rb

@@ -86,7 +86,7 @@ def gem_changelog_path(gem_name, from: :directory)
     when :directory
       path
     when :context
-      ::File.expand_path(path, gem_directory(gem_name))
+      ::File.join(gem_directory(gem_name), path)
     when :absolute
       ::File.expand_path(path, gem_directory(gem_name, from: :absolute))
     else
@@ -100,7 +100,7 @@ def gem_version_rb_path(gem_name, from: :directory)
     when :directory
       path
     when :context
-      ::File.expand_path(path, gem_directory(gem_name))
+      ::File.join(gem_directory(gem_name), path)
     when :absolute
       ::File.expand_path(path, gem_directory(gem_name, from: :absolute))
     else

.toys/release/_onclosed.rb

@@ -89,7 +89,7 @@ def handle_release_merged
   performer = create_performer
   github_check_errors = @utils.wait_github_checks
   if github_check_errors.empty?
-    find_gems_and_versions.each do |gem_name, gem_version|
+    @utils.released_gems_and_versions(@pr_info).each do |gem_name, gem_version|
       if performer.instance(gem_name, gem_version).perform
         puts("SUCCESS: Released #{gem_name} #{gem_version}", :bold, :green)
       end
@@ -110,35 +110,6 @@ def setup_git
   exec(["git", "checkout", "release/current"])
 end
 
-def find_gems_and_versions
-  gem_name =
-    if @utils.all_gems.size == 1
-      @utils.default_gem
-    else
-      @utils.gem_name_from_release_branch(@pr_info["head"]["ref"])
-    end
-  if gem_name
-    gem_version = @utils.current_library_version(gem_name)
-    logger.info("Found single gem to release: #{gem_name} #{gem_version}.")
-    result = { gem_name => gem_version }
-    return result
-  end
-  gems_and_versions_from_git
-end
-
-def gems_and_versions_from_git
-  output = capture(["git", "diff", "--name-only", "release/current^..release/current"])
-  files = output.split("\n")
-  gems = @utils.all_gems.find_all do |gem_name|
-    dir = @utils.gem_directory(gem_name)
-    files.any? { |file| file.start_with?(dir) }
-  end
-  gems.each_with_object({}) do |gem_name, result|
-    result[gem_name] = gem_version = @utils.current_library_version(gem_name)
-    logger.info("Releasing gem due to file changes: #{gem_name} #{gem_version}.")
-  end
-end
-
 def create_performer
   require "release_performer"
   dry_run = /^t/i =~ enable_releases.to_s ? false : true

.toys/release/gen-workflows.rb

@@ -38,10 +38,10 @@ def run
   @workflows_dir = ::File.join(context_directory, ".github", "workflows")
   files = [
     "release-hook-on-closed.yml",
-    "release-hook-on-open.yml",
     "release-hook-on-push.yml",
     "release-perform.yml",
     "release-request.yml",
+    "release-retry.yml",
   ]
 
   files.each { |name| generate(name) }