toys-release 0.2.2 → 0.3.0

data/toys/.lib/toys/release/repository.rb

@@ -512,7 +512,7 @@ module Toys
         @components = {}
         @utils.accumulate_errors("Errors while validating components") do
           settings.all_component_names.each do |name|
-            releasable = Component.build(settings, name, @utils)
+            releasable = Component.new(settings, name, @utils)
             releasable.validate
             @components[releasable.name] = releasable
           end
@@ -594,7 +594,7 @@ module Toys
         results << "No GitHub checks found for #{ref}" if checks.empty?
         checks.each do |check|
           name = check["name"]
-          next if @settings.release_jobs_regexp.match(name)
+          next if name.start_with?("release-")
           next unless @settings.required_checks_regexp.match(name)
           if check["status"] != "completed"
             results << "GitHub check #{name.inspect} is not complete"
@@ -612,7 +612,7 @@ module Toys
       def single_released_component_and_version(pull_request)
         component_name =
           if @settings.all_component_names.size == 1
-            @settings.default_component_name
+            @settings.all_component_names.first
           else
             component_name_from_release_branch(pull_request.head_ref)
           end

data/toys/.lib/toys/release/steps.rb

@@ -63,10 +63,16 @@ module Toys
         # @private
         def run(step_context)
           tool = Array(step_context.option("tool", required: true))
+          chdir = step_context.option("chdir", default: ".")
           step_context.log("Running tool #{tool.inspect}...")
-          result = step_context.utils.exec_separate_tool(tool, out: [:child, :err])
+          result = step_context.utils.exec_separate_tool(tool, chdir: chdir, out: [:child, :err])
           unless result.success?
-            step_context.abort_pipeline("Tool failed: #{tool.inspect}. Check the logs for details.")
+            if step_context.option("continue_on_error")
+              step_context.warning("Tool failed: #{tool.inspect}.")
+              step_context.exit_step
+            else
+              step_context.abort_pipeline("Tool failed: #{tool.inspect}. Check the logs for details.")
+            end
           end
           step_context.log("Completed tool")
         end
@@ -82,10 +88,16 @@ module Toys
         # @private
         def run(step_context)
           command = Array(step_context.option("command", required: true))
+          chdir = step_context.option("chdir", default: ".")
           step_context.log("Running command #{command.inspect}...")
-          result = step_context.utils.exec(command, out: [:child, :err])
+          result = step_context.utils.exec(command, chdir: chdir, out: [:child, :err])
           unless result.success?
-            step_context.abort_pipeline("Command failed: #{command.inspect}. Check the logs for details.")
+            if step_context.option("continue_on_error")
+              step_context.warning("Command failed: #{command.inspect}.")
+              step_context.exit_step
+            else
+              step_context.abort_pipeline("Command failed: #{command.inspect}. Check the logs for details.")
+            end
           end
           step_context.log("Completed command")
         end
@@ -98,18 +110,23 @@ module Toys
       class << BUNDLE
         # @private
         def run(step_context)
+          chdir = step_context.option("chdir", default: ".")
           component = step_context.component
           step_context.log("Running bundler for #{component.name} ...")
-          component.bundle
+          ::Dir.chdir(chdir) do
+            result = component.bundle
+            unless result.success?
+              step_context.abort_pipeline("Bundle failed for #{component.name}. Check the logs for details.")
+            end
+          end
           step_context.log("Completed bundler for #{component.name}")
           step_context.copy_to_output(source_path: "Gemfile.lock")
         end
       end
 
       ##
-      # A step that builds the gem, and leaves the built gem file in the step's
-      # artifact directory. This step can also run a pre_command and/or a
-      # pre_tool.
+      # A step that builds the gem, and leaves the built gem package file in
+      # the step's output directory.
       #
       BUILD_GEM = ::Object.new
       class << BUILD_GEM
@@ -133,9 +150,8 @@ module Toys
       end
 
       ##
-      # A step that builds yardocs, and leaves the built documentation file in
-      # the step's artifact directory. This step can also run a pre_command
-      # and/or a pre_tool.
+      # A step that builds yardocs, and leaves the built documentation in the
+      # step's output directory.
       #
       BUILD_YARD = ::Object.new
       class << BUILD_YARD
@@ -144,7 +160,7 @@ module Toys
           if step_context.option("uses_gems")
             []
           else
-            ["bundle"]
+            [step_context.option("bundle_step", default: "bundle")]
           end
         end
 
@@ -169,10 +185,10 @@ module Toys
 
         def setup_gems(step_context)
           if (uses_gems = step_context.option("uses_gems"))
-            ::Toys::Utils::Gems.activate("yard")
             Array(uses_gems).each do |gem_info|
               ::Toys::Utils::Gems.activate(*Array(gem_info))
             end
+            ::Toys::Utils::Gems.activate("yard")
             [
               "gem 'yard'",
               "puts 'Loading gems explicitly: #{uses_gems.inspect}'",
@@ -189,15 +205,14 @@ module Toys
       end
 
       ##
-      # A step that releases a gem built by a previous run of BuildGem. The
-      # `"input"` option provides the name of the artifact directory containing
-      # the built gem.
+      # A step that releases a gem built by a previous step, normally a
+      # run of BUILD_GEM.
       #
       RELEASE_GEM = ::Object.new
       class << RELEASE_GEM
         # @private
-        def primary?(_step_context)
-          true
+        def primary?(step_context)
+          ::File.file?("#{step_context.component.name}.gemspec")
         end
 
         # @private
@@ -224,7 +239,10 @@ module Toys
 
         def check_existence(step_context)
           step_context.log("Checking whether #{step_context.release_description} already exists...")
-          if step_context.component.version_released?(step_context.release_version)
+          gem_name = step_context.component.name
+          gem_version = step_context.release_version.to_s
+          cmd = ["gem", "search", gem_name, "--exact", "--remote", "--version", gem_version]
+          if step_context.utils.capture(cmd).include?("#{gem_name} (#{gem_version})")
             step_context.warning("Gem already pushed for #{step_context.release_description}. Skipping.")
             step_context.add_success("Gem already pushed for #{step_context.release_description}")
             step_context.exit_step
@@ -260,9 +278,8 @@ module Toys
       end
 
       ##
-      # A step that pushes to gh-pages documentation built by a previous run of
-      # BuildYard. The `"input"` option provides the name of the artifact
-      # directory containing the built documentation.
+      # A step that pushes to gh-pages documentation built by a previous step,
+      # normally an instance of BUILD_YARD.
       #
       PUSH_GH_PAGES = ::Object.new
       class << PUSH_GH_PAGES

data/toys/.toys.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-toys_version!("~> 0.17")
+toys_version!("~> 0.18")
 
-desc "Release tools namespace"
+desc "Namespace for toys-release tools"

data/toys/_onclosed.rb

@@ -83,6 +83,7 @@ end
 
 def handle_release_merged
   setup_git
+  report_release_starting
   github_check_errors = @repository.wait_github_checks
   unless github_check_errors.empty?
     @utils.error("GitHub checks failed", *github_check_errors)
@@ -103,6 +104,13 @@ def setup_git
   exec(["git", "switch", "release/current"], e: true)
 end
 
+def report_release_starting
+  reports = ["Starting release automation."]
+  url = @utils.current_workflow_run_url
+  reports << "See #{url} for execution logs." if url
+  @pull_request.add_comment(reports.join(" "))
+end
+
 def create_performer
   require "toys/release/performer"
   dry_run = /^t/i.match?(::ENV["TOYS_RELEASE_DRY_RUN"].to_s)

data/toys/gen-config.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+desc "Generate an initial config file"
+
+long_desc \
+  "This tool generates an initial config file for this repo." \
+    " You will generally need to make additional edits to this file after" \
+    " initial generation."
+
+flag :repo, "--repo=REPO" do
+  desc "GitHub repo owner and name (e.g. dazuma/toys)"
+end
+flag :git_user, "--git-user=NAME" do
+  default ""
+  desc "User name for git commits (defaults to the git user.name config)"
+end
+flag :git_email, "--git-email=EMAIL" do
+  default ""
+  desc "User email for git commits (defaults to the git user.email config)"
+end
+flag :file_path, "-o PATH", "--output=PATH" do
+  desc "Output file path (defaults to .toys/.data/releases.yml)"
+end
+flag :yes, "--yes", "-y" do
+  desc "Automatically answer yes to all confirmations"
+end
+
+include :exec, e: true
+include :terminal, styled: true
+include :fileutils
+
+def run
+  setup
+  interpret_github_repo
+  interpret_git_user
+  check_file_path
+  gems_and_dirs = find_gems
+  confirm_with_user
+  mkdir_p(::File.dirname(file_path))
+  ::File.open(file_path, "w") do |file|
+    write_settings(file, gems_and_dirs)
+  end
+  puts("Wrote initial config file to #{file_path}.", :green, :bold)
+end
+
+def setup
+  require "toys/release/environment_utils"
+  @utils = Toys::Release::EnvironmentUtils.new(self)
+  cd(@utils.repo_root_directory)
+end
+
+def interpret_github_repo
+  return if repo
+  current_guess = nil
+  capture(["git", "remote", "-v"]).split("\n").each do |line|
+    match = %r{^(\S+)\s+git@github\.com:([^/.\s]+/[^/.\s]+)(?:\.git)?}.match(line)
+    current_guess = match[2] if match && (match[1] == "origin" || current_guess.nil?)
+    match = %r{^(\S+)\s+https://github\.com/([^/.\s]+/[^/.\s]+)(?:\.git)?}.match(line)
+    current_guess = match[2] if match && (match[1] == "origin" || current_guess.nil?)
+  end
+  if current_guess.nil?
+    puts "Unable to determine the GitHub repo associated with this repository.", :red, :bold
+    exit(1)
+  end
+  puts "GitHub repository inferred to be #{current_guess}."
+  puts "If this is incorrect, specify the correct repo using the --repo= flag."
+  set(:repo, current_guess)
+end
+
+def interpret_git_user
+  if git_user.empty?
+    set(:git_user, capture(["git", "config", "get", "user.name"]).strip)
+    if git_user.empty?
+      puts "Unable to determine git user.name. Using a hard-coded fallback", :yellow
+      set(:git_user, "Example User")
+    else
+      puts "Using the current git user.name of #{git_user}"
+    end
+  end
+  if git_email.empty?
+    set(:git_email, capture(["git", "config", "get", "user.email"]).strip)
+    if git_email.empty?
+      puts "Unable to determine git user.email. Using a hard-coded fallback", :yellow
+      set(:git_email, "hello@example.com")
+    else
+      puts "Using the current git user.email of #{git_email}"
+    end
+  end
+end
+
+def check_file_path
+  set(:file_path, ::File.join(".toys", ".data", "releases.yml")) unless file_path
+  if ::File.readable?(file_path)
+    puts "Cannot overwrite existing file: #{file_path}", :red, :bold
+    exit(1)
+  end
+end
+
+def confirm_with_user
+  exit unless yes || confirm("Create config file #{file_path}? ", default: true)
+end
+
+def find_gems
+  toplevel = ::Dir.glob("*.gemspec")
+  subdirs = ::Dir.glob("*/*.gemspec")
+  if toplevel.size > 1
+    puts "Unexpected: Found multiple gemspecs at the top level.", :red, :bold
+    exit(1)
+  end
+  if toplevel.size == 1 && subdirs.empty?
+    path = toplevel.first
+    puts "Found #{path} at the toplevel of the repo."
+    [[::File.basename(path, ".gemspec"), "."]]
+  elsif toplevel.empty? && !subdirs.empty?
+    subdirs.map do |path|
+      puts "Found #{path} in the repo."
+      [::File.basename(path, ".gemspec"), ::File.dirname(path)]
+    end
+  else
+    puts "Unexpected: Found gemspecs at the toplevel and in subdirectories.", :red, :bold
+    exit(1)
+  end
+end
+
+def write_settings(file, gems_and_dirs)
+  file.puts("repo: #{repo}")
+  file.puts("git_user_name: #{git_user}")
+  file.puts("git_user_email: #{git_email}")
+  file.puts("# Insert additional repo-level settings here.")
+  file.puts
+  file.puts("gems:")
+  gems_and_dirs.sort_by(&:first).each do |(name, dir)|
+    file.puts("  - name: #{name}")
+    file.puts("    directory: #{dir}")
+    file.puts("    # Insert additional gem-level settings here.")
+  end
+end

data/toys/gen-workflows.rb

@@ -5,12 +5,16 @@ desc "Generate GitHub Actions workflow files"
 long_desc \
   "This tool generates workflow files for GitHub Actions."
 
+flag :workflows_dir, "-o PATH", "--output=PATH" do
+  desc "Output directory (defaults to .github/workflows)"
+end
 flag :yes, "--yes", "-y" do
   desc "Automatically answer yes to all confirmations"
 end
 
-include :exec
+include :exec, e: true
 include :terminal, styled: true
+include :fileutils
 
 # Context for ERB templates
 class ErbContext
@@ -24,21 +28,35 @@ class ErbContext
 end
 
 def run
+  setup
+  user_confirmation
+  generate_all_files
+end
+
+def setup
   require "erb"
+  require "fileutils"
   require "toys/release/environment_utils"
   require "toys/release/repo_settings"
 
   @utils = Toys::Release::EnvironmentUtils.new(self)
+  cd(@utils.repo_root_directory)
   @settings = Toys::Release::RepoSettings.load_from_environment(@utils)
 
+  set(:workflows_dir, ::File.join(".github", "workflows")) if workflows_dir.to_s.empty?
+end
+
+def user_confirmation
   unless @settings.enable_release_automation?
     puts "Release automation disabled in settings."
     unless yes || confirm("Create workflow files anyway? ", default: false)
       @utils.error("Aborted.")
     end
   end
+end
 
-  @workflows_dir = ::File.join(context_directory, ".github", "workflows")
+def generate_all_files
+  mkdir_p(workflows_dir)
   files = [
     "release-hook-on-closed.yml",
     "release-hook-on-push.yml",
@@ -46,12 +64,11 @@ def run
     "release-request.yml",
     "release-retry.yml",
   ]
-
-  files.each { |name| generate(name) }
+  files.each { |name| generate_file(name) }
 end
 
-def generate(name)
-  destination = ::File.join(@workflows_dir, name)
+def generate_file(name)
+  destination = ::File.join(workflows_dir, name)
   if ::File.readable?(destination)
     puts "Destination file #{destination} exists.", :yellow, :bold
     return unless yes || confirm("Overwrite? ", default: true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toys-release
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -71,8 +71,8 @@ files:
 - toys/_onclosed.rb
 - toys/_onpush.rb
 - toys/create-labels.rb
+- toys/gen-config.rb
 - toys/gen-gh-pages.rb
-- toys/gen-settings.rb
 - toys/gen-workflows.rb
 - toys/perform.rb
 - toys/request.rb
@@ -81,10 +81,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys-release/v0.2.2/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-release/v0.3.0/file.CHANGELOG.html
   source_code_uri: https://github.com/dazuma/toys/tree/main/toys-release
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys-release/v0.2.2
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-release/v0.3.0
 rdoc_options: []
 require_paths:
 - lib

data/toys/gen-settings.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-desc "Generate initial settings file"
-
-long_desc \
-  "This tool generates an initial settings file for this repo." \
-    " You will generally need to make additional edits to this file after" \
-    " initial generation."
-
-required_arg :repo do
-  desc "GitHub repo owner and name (e.g. dazuma/toys)"
-end
-
-flag :yes, "--yes", "-y" do
-  desc "Automatically answer yes to all confirmations"
-end
-
-include :exec
-include :terminal, styled: true
-
-def run
-  file_path = ::File.join(context_directory, ".toys", ".data", "releases.yml")
-  if ::File.readable?(file_path)
-    puts "Cannot overwrite existing file: #{file_path}", :red, :bold
-    exit(1)
-  end
-  return unless yes || confirm("Create file #{file_path}? ", default: true)
-  ::File.open(file_path, "w") do |file|
-    write_settings(file)
-  end
-  puts("Wrote initial settings file: #{file_path}.", :green, :bold)
-end
-
-def write_settings(file)
-  file.puts("repo: #{repo}")
-  file.puts("# Insert additional repo-level settings here.")
-  file.puts
-  file.puts("gems:")
-  ::Dir.glob("**/*.gemspec").each do |gemspec|
-    gem_name = ::File.basename(gemspec, ".gemspec")
-    file.puts("  - name: #{gem_name}")
-    dir = ::File.dirname(gemspec)
-    file.puts("    directory: #{dir}") if dir != gem_name
-    file.puts("    # Insert additional gem-level settings here.")
-  end
-end