toys-release 0.1.1 → 0.3.0

data/lib/toys/release/version.rb

@@ -6,6 +6,6 @@ module Toys
     # Current version of the Toys release system.
     # @return [String]
     #
-    VERSION = "0.1.1"
+    VERSION = "0.3.0"
   end
 end

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

@@ -24,7 +24,7 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Install Toys
         run: "gem install --no-document toys"
       - name: Open release pull request

data/toys/.lib/toys/release/artifact_dir.rb

@@ -15,11 +15,13 @@ module Toys
       # @param base_dir [String] Optional base directory, within which all the
       #     artifact directories will be created. If not provided, a temporary
       #     directory will be used.
+      # @param auto_cleanup [boolean] Whether to cleanup automatically at_exit.
       #
-      def initialize(base_dir = nil)
+      def initialize(base_dir = nil, auto_cleanup: false)
         @base_dir = base_dir
         @needs_cleanup = false
         @initialized = {}
+        at_exit { cleanup } if auto_cleanup
       end
 
       ##
@@ -40,6 +42,24 @@ module Toys
         path
       end
 
+      ##
+      # Get the path to the output directory for the given step name.
+      #
+      # @param name [String] Step name
+      #
+      def output(name)
+        get("out-#{name}")
+      end
+
+      ##
+      # Get the path to the temp directory for the given step name.
+      #
+      # @param name [String] Step name
+      #
+      def temp(name)
+        get("temp-#{name}")
+      end
+
       ##
       # Perform cleanup, removing the directories if they were created under a
       # temporary directory.

data/toys/.lib/toys/release/change_set.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "semver"
+require "toys/release/semver"
 
 module Toys
   module Release
@@ -14,12 +14,12 @@ module Toys
       ##
       # Create a new ChangeSet
       #
-      # @param settings [RepoSettings] the repo settings
+      # @param component_settings [ComponentSettings] the component settings
       #
-      def initialize(settings)
-        @release_commit_tags = settings.release_commit_tags
-        @breaking_change_header = settings.breaking_change_header
-        @no_significant_updates_notice = settings.no_significant_updates_notice
+      def initialize(component_settings)
+        @commit_tags = component_settings.commit_tags
+        @breaking_change_header = component_settings.breaking_change_header
+        @no_significant_updates_notice = component_settings.no_significant_updates_notice
         @semver = Semver::NONE
         @change_groups = nil
         @inputs = []
@@ -49,7 +49,7 @@ module Toys
         raise "ChangeSet locked" if finished?
         @semver = Semver::NONE
         change_groups = {breaking: Group.new(@breaking_change_header)}
-        @release_commit_tags.each_value do |tag_info|
+        @commit_tags.each do |tag_info|
           tag_info.all_headers.each { |header| change_groups[header] = Group.new(header) }
         end
         @inputs.each do |input|
@@ -187,7 +187,7 @@ module Toys
         when /^revert-commit$/i
           @inputs.delete_if { |elem| elem.sha.start_with?(match[:content].split.first) }
         else
-          tag_info = @release_commit_tags[match[:tag]]
+          tag_info = @commit_tags.find { |tag| tag.tag == match[:tag] }
           input.apply_commit(tag_info, match[:scope], match[:bang], match[:content])
         end
       end

data/toys/.lib/toys/release/component.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "change_set"
-require_relative "changelog_file"
-require_relative "version_rb_file"
+require "toys/release/change_set"
+require "toys/release/changelog_file"
+require "toys/release/version_rb_file"
 
 module Toys
   module Release
@@ -11,25 +11,15 @@ module Toys
     #
     class Component
       ##
-      # Factory method
+      # Constructor
       #
       # @param repo_settings [Toys::Release::RepoSettings] the repo settings
       # @param name [String] The component name
       # @param environment_utils [Toys::Release::EnvironmentUtils] env utils
       #
-      def self.build(repo_settings, name, environment_utils)
-        settings = repo_settings.component_settings(name)
-        if settings.type == "gem"
-          GemComponent.new(repo_settings, settings, environment_utils)
-        else
-          Component.new(repo_settings, settings, environment_utils)
-        end
-      end
-
-      # @private
-      def initialize(repo_settings, settings, environment_utils)
+      def initialize(repo_settings, name, environment_utils)
         @repo_settings = repo_settings
-        @settings = settings
+        @settings = repo_settings.component_settings(name)
         @utils = environment_utils
         @changelog_file = ChangelogFile.new(changelog_path(from: :absolute), @utils)
         @version_rb_file = VersionRbFile.new(version_rb_path(from: :absolute), @utils, @settings.version_constant)
@@ -83,17 +73,17 @@ module Toys
 
       ##
       # Returns the directory path. It can be returned either as a relative path
-      # from the context directory or an absolute path.
+      # from the repo root directory or an absolute path.
       #
-      # @param from [:context,:absolute] From where (defaults to `:context`)
+      # @param from [:repo_root,:absolute] From where (defaults to `:repo_root`)
       # @return [String] The directory path
       #
-      def directory(from: :context)
+      def directory(from: :repo_root)
         case from
-        when :context
+        when :repo_root
           settings.directory
         when :absolute
-          ::File.expand_path(settings.directory, @utils.context_directory)
+          ::File.expand_path(settings.directory, @utils.repo_root_directory)
         else
           raise ArgumentError, "Unknown from value: #{from.inspect}"
         end
@@ -101,10 +91,10 @@ module Toys
 
       ##
       # Returns the path to a given file. It can be returned as a relative path
-      # from the component directory, a relative path from the context
+      # from the component directory, a relative path from the repo root
       # directory, or an absolute path.
       #
-      # @param from [:directory,:context,:absolute] From where (defaults to
+      # @param from [:directory,:repo_root,:absolute] From where (defaults to
       #     `:directory`)
       # @return [String] The path to the file
       #
@@ -112,7 +102,7 @@ module Toys
         case from
         when :directory
           path
-        when :context
+        when :repo_root
           ::File.join(directory, path)
         when :absolute
           ::File.expand_path(path, directory(from: :absolute))
@@ -123,10 +113,10 @@ module Toys
 
       ##
       # Returns the path to the changelog. It can be returned as a relative
-      # path from the component directory, a relative path from the context
+      # path from the component directory, a relative path from the repo root
       # directory, or an absolute path.
       #
-      # @param from [:directory,:context,:absolute] From where (defaults to
+      # @param from [:directory,:repo_root,:absolute] From where (defaults to
       #     `:directory`)
       # @return [String] The path to the changelog
       #
@@ -136,10 +126,10 @@ module Toys
 
       ##
       # Returns the path to the version.rb. It can be returned as a relative
-      # path from the component directory, a relative path from the context
+      # path from the component directory, a relative path from the repo root
       # directory, or an absolute path.
       #
-      # @param from [:directory,:context,:absolute] From where (defaults to
+      # @param from [:directory,:repo_root,:absolute] From where (defaults to
       #     `:directory`)
       # @return [String] The path to the `version.rb` file
       #
@@ -213,7 +203,7 @@ module Toys
       #
       def current_changelog_version(at: nil)
         if at
-          path = changelog_path(from: :context)
+          path = changelog_path(from: :repo_root)
           content = @utils.capture(["git", "show", "#{at}:#{path}"], e: true)
           return ChangelogFile.current_version_from_content(content)
         end
@@ -228,7 +218,7 @@ module Toys
       #
       def current_constant_version(at: nil)
         if at
-          path = version_rb_path(from: :context)
+          path = version_rb_path(from: :repo_root)
           content = @utils.capture(["git", "show", "#{at}:#{path}"], e: true)
           return VersionRbFile.current_version_from_content(content)
         end
@@ -267,7 +257,7 @@ module Toys
         to ||= "HEAD"
         from = latest_tag(ref: to) if from == :default
         commits = from ? "#{from}..#{to}" : to
-        changeset = ChangeSet.new(@repo_settings)
+        changeset = ChangeSet.new(@settings)
         shas = @utils.capture(["git", "log", commits, "--format=%H"], e: true).split("\n")
         shas.reverse_each do |sha|
           message = touched_message(sha)
@@ -279,12 +269,14 @@ module Toys
       ##
       # Run bundler
       #
+      # @return [Toys::Utils::Exec::Result]
+      #
       def bundle
         cd do
           exec_result = @utils.exec(["bundle", "install"])
           @utils.error("Bundle install failed for #{name}.") unless exec_result.success?
+          exec_result
         end
-        self
       end
 
       ##
@@ -331,58 +323,5 @@ module Toys
         name.hash
       end
     end
-
-    ##
-    # Subclass for Gem components
-    #
-    class GemComponent < Component
-      ##
-      # Returns the path to the gemspec. It can be returned as a relative path
-      # from the component directory, a relative path from the context
-      # directory, or an absolute path.
-      #
-      # @param from [:directory,:context,:absolute] From where (defaults to
-      #     `:directory`)
-      # @return [String] The path to the gemspec file
-      #
-      def gemspec_path(from: :directory)
-        file_path("#{name}.gemspec", from: from)
-      end
-
-      ##
-      # Validates the component and reports any errors.
-      # Includes both errors from the base class and gem-specific errors.
-      #
-      def validate
-        super do
-          path = gemspec_path(from: :absolute)
-          @utils.error("Missing gemspec #{path} for #{name}") unless ::File.file?(path)
-        end
-      end
-
-      ##
-      # Return a list of released versions
-      #
-      # @return [Array<::Gem::Version>]
-      #
-      def released_versions
-        content = @utils.capture(["gem", "info", "-r", "-a", name], e: true)
-        match = /#{name} \(([\w., ]+)\)/.match(content)
-        return [] unless match
-        match[1].split(/,\s+/).map { |str| ::Gem::Version.new(str) }
-      end
-
-      ##
-      # Determines if a version has been released
-      #
-      # @param version [::Gem::Version,String] The version to check
-      # @return [boolean] Whether the version has been released
-      #
-      def version_released?(version)
-        cmd = ["gem", "search", name, "--exact", "--remote", "--version", version.to_s]
-        content = @utils.capture(cmd)
-        content.include?("#{name} (#{version})")
-      end
-    end
   end
 end

data/toys/.lib/toys/release/environment_utils.rb

@@ -74,6 +74,13 @@ module Toys
         tool_context.context_directory
       end
 
+      ##
+      # @return [String] Absolute path to the repo root directory
+      #
+      def repo_root_directory
+        @repo_root_directory ||= capture(["git", "rev-parse", "--show-toplevel"], chdir: context_directory).strip
+      end
+
       ##
       # Log a message at INFO level
       #
@@ -120,10 +127,13 @@ module Toys
       #
       def accumulate_errors(main_message = nil)
         previous_list = @error_list
-        @error_list = []
-        result = yield
-        current_list = @error_list
-        @error_list = previous_list
+        @error_list = current_list = []
+        result =
+          begin
+            yield
+          ensure
+            @error_list = previous_list
+          end
         unless current_list.empty?
           current_list.unshift(main_message) if main_message
           error(*current_list)
@@ -141,11 +151,11 @@ module Toys
       # @return [Object] The block's result if success
       # @return [nil] if errors happened
       #
-      def capture_errors(errors = nil)
+      def capture_errors(errors = nil, &block)
         return yield unless errors
         previous_option = on_error_option
         @on_error_option = :raise
-        yield
+        accumulate_errors(&block)
       rescue ReleaseError => e
         errors.concat(e.all_messages)
         nil
@@ -231,6 +241,19 @@ module Toys
         tool_context.exec_separate_tool(cmd, **opts, &block)
       end
 
+      ##
+      # Returns the URL for the current GitHub Actions workflow run.
+      #
+      # @return [String] Current workflow run URL
+      # @return [nil] If not called from within a workflow run
+      #
+      def current_workflow_run_url
+        return nil unless (server_url = ::ENV["GITHUB_SERVER_URL"])
+        return nil unless (repo = ::ENV["GITHUB_REPOSITORY"])
+        return nil unless (run_id = ::ENV["GITHUB_RUN_ID"])
+        "#{server_url}/#{repo}/actions/runs/#{run_id}"
+      end
+
       private
 
       def modify_exec_opts(opts, cmd)

data/toys/.lib/toys/release/performer.rb

@@ -3,8 +3,9 @@
 require "fileutils"
 require "json"
 
-require_relative "artifact_dir"
-require_relative "steps"
+require "toys/release/artifact_dir"
+require "toys/release/pipeline"
+require "toys/release/steps"
 
 module Toys
   module Release
@@ -30,10 +31,10 @@ module Toys
         end
 
         ##
-        # @return [boolean] Whether the result is capturing errors
+        # @return [boolean] Whether there were no errors
         #
-        def capture_errors?
-          !@errors.nil?
+        def succeeded?
+          @errors.empty?
         end
 
         ##
@@ -205,28 +206,13 @@ module Toys
       #
       def report_results
         report_text = build_report_text
-        if @pull_request
-          @utils.log("Updating release pull request #{@pull_request.url} ...")
-          label = error? ? @settings.release_error_label : @settings.release_complete_label
-          @pull_request.update(labels: label)
-          @pull_request.add_comment(report_text)
-          @utils.log("Updated release pull request #{@pull_request.url}")
-        end
-        if error?
-          @utils.log("Opening a new issue to report the failure ...")
-          body = <<~STR
-            A release job failed.
-
-            Release PR: #{@pull_request&.url || 'unknown'}
-            Commit: https://github.com/#{@settings.repo_path}/commit/#{@release_sha}
-
-            ----
-
-            #{report_text}
-          STR
-          title = "Release PR ##{@pull_request&.number || 'unknown'} failed with errors"
-          issue_number = @repository.open_issue(title, body)["number"]
-          @utils.log("Issue ##{issue_number} opened")
+        puts report_text
+        if @dry_run
+          @utils.warning("DRY RUN: Skipped updating pull request #{@pull_request.url}") if @pull_request
+          @utils.warning("DRY RUN: Skipped opening release failure issue") if error?
+        else
+          update_pull_request(report_text) if @pull_request
+          open_error_issue(report_text) if error?
         end
         self
       end
@@ -274,13 +260,8 @@ module Toys
                  else
                    "* **All releases completed successfully.**"
                  end
-        if (server_url = ::ENV["GITHUB_SERVER_URL"])
-          if (repo = ::ENV["GITHUB_REPOSITORY"])
-            if (run_id = ::ENV["GITHUB_RUN_ID"])
-              lines << "* Run logs: #{server_url}/#{repo}/actions/runs/#{run_id}"
-            end
-          end
-        end
+        url = @utils.current_workflow_run_url
+        lines << "* Run logs: #{url}" if url
         lines
       end
 
@@ -317,17 +298,16 @@ module Toys
 
       def internal_perform_release(component, version, result)
         component_prechecks(component, version) if @enable_prechecks
-        artifact_dir = Toys::Release::ArtifactDir.new(@work_dir)
+        artifact_dir = ArtifactDir.new(@work_dir)
         begin
           component.cd do
-            component.settings.steps.each do |step_settings|
-              result_code = Toys::Release::Steps.run(
-                type: step_settings.type, name: step_settings.name, options: step_settings.options,
-                repository: @repository, component: component, version: version, performer_result: result,
-                artifact_dir: artifact_dir, dry_run: @dry_run, git_remote: @git_remote
-              )
-              break if result_code == :abort
-            end
+            pipeline = Pipeline.new(
+              repository: @repository, component: component, version: version, performer_result: result,
+              artifact_dir: artifact_dir, dry_run: @dry_run, git_remote: @git_remote
+            )
+            component.settings.steps.each { |step_settings| pipeline.add_step(step_settings) }
+            pipeline.resolve_run
+            pipeline.run
           end
         ensure
           artifact_dir.cleanup
@@ -341,6 +321,31 @@ module Toys
         @utils.log("Completed prechecks for #{component.name.inspect}")
         self
       end
+
+      def update_pull_request(report_text)
+        @utils.log("Updating release pull request #{@pull_request.url} ...")
+        label = error? ? @settings.release_error_label : @settings.release_complete_label
+        @pull_request.update(labels: label)
+        @pull_request.add_comment(report_text)
+        @utils.log("Updated release pull request #{@pull_request.url}")
+      end
+
+      def open_error_issue(report_text)
+        @utils.log("Opening a new issue to report the failure ...")
+        body = <<~STR
+          A release job failed.
+
+          Release PR: #{@pull_request&.url || 'unknown'}
+          Commit: https://github.com/#{@settings.repo_path}/commit/#{@release_sha}
+
+          ----
+
+          #{report_text}
+        STR
+        title = "Release PR ##{@pull_request&.number || 'unknown'} failed with errors"
+        issue_number = @repository.open_issue(title, body)["number"]
+        @utils.log("Issue ##{issue_number} opened")
+      end
     end
   end
 end