toys-release 0.2.2 → 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.2.2"
+    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/change_set.rb

@@ -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

@@ -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)
@@ -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 repo root
-      # directory, or an absolute path.
-      #
-      # @param from [:directory,:repo_root,: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

@@ -241,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

@@ -260,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
 

data/toys/.lib/toys/release/pipeline.rb

@@ -236,9 +236,13 @@ module Toys
         # @param source_step [String] Name of the source step
         # @param source_path [String] Path to the file or directory to copy
         # @param dest [:component,:repo_root,:temp,:output] Symbolic destination
-        # @param dest_path [String] Path in the destination
+        # @param dest_path [String,nil] Path in the destination, if different
+        #     from the source
+        # @param collisions [:error,:replace,:keep] What to do if a collision
+        #     occurs
         #
-        def copy_from_input(source_step, source_path: nil, dest: :component, dest_path: nil)
+        def copy_from_input(source_step, source_path: nil, dest: :component, dest_path: nil, collisions: nil)
+          collisions ||= "error"
           source_dir = output_dir(source_step)
           source_path ||= "."
           dest_path ||= source_path
@@ -258,16 +262,21 @@ module Toys
           source = ::File.expand_path(source_path, source_dir)
           dest = ::File.expand_path(dest_path, dest_dir)
           utils.log("Copying #{source_path.inspect} from step #{source_step.inspect}")
-          @pipeline.copy_tree(self, source, dest, source_path)
+          @pipeline.copy_tree(self, source, dest, source_path, collisions.to_s)
         end
 
         ##
         # Copy the given item to the output directory
         #
-        # @param source_path [String] Path to the file or directory to copy
         # @param source [:component,:repo_root,:temp] Symbolic source
+        # @param source_path [String] Path to the file or directory to copy
+        # @param dest_path [String,nil] Path in the destination, if different
+        #     from the source
+        # @param collisions [:error,:replace,:keep] What to do if a collision
+        #     occurs
         #
-        def copy_to_output(source: :component, source_path: nil, dest_path: nil)
+        def copy_to_output(source: :component, source_path: nil, dest_path: nil, collisions: nil)
+          collisions ||= "error"
           source_path ||= "."
           dest_path ||= source_path
           source_dir =
@@ -284,7 +293,7 @@ module Toys
           source = ::File.expand_path(source_path, source_dir)
           dest = ::File.expand_path(dest_path, output_dir)
           utils.log("Copying #{source_path.inspect} to output")
-          @pipeline.copy_tree(self, source, dest, source_path)
+          @pipeline.copy_tree(self, source, dest, source_path, collisions.to_s)
         end
 
         # ---- called internally from the pipeline ----
@@ -367,6 +376,7 @@ module Toys
             mark_step_index(index)
           end
         end
+        self
       end
 
       ##
@@ -393,23 +403,25 @@ module Toys
             return nil
           end
         end
+        self
       end
 
       ##
       # @private
       #
-      def copy_tree(step, src, dest, src_name)
+      def copy_tree(step, src, dest, src_name, collisions)
         if ::File.directory?(src)
           if ::File.exist?(dest) && !::File.directory?(dest)
-            step.abort_pipeline("Unable to copy #{src_name} because a non-directory exists at the destination")
+            return if handle_copy_collision(step, collisions, dest, src_name) == :keep
           end
           ::FileUtils.mkdir_p(dest)
           ::Dir.children(src).each do |child|
-            copy_tree(step, ::File.join(src, child), ::File.join(dest, child), ::File.join(src_name, child))
+            copy_tree(step, ::File.join(src, child), ::File.join(dest, child),
+                      ::File.join(src_name, child), collisions)
           end
         elsif ::File.exist?(src)
           if ::File.exist?(dest)
-            step.abort_pipeline("Unable to copy #{src_name} because something already exists at the destination")
+            return if handle_copy_collision(step, collisions, dest, src_name) == :keep
           end
           ::FileUtils.copy_entry(src, dest)
         else
@@ -514,7 +526,7 @@ module Toys
             end
           dest = ::File.expand_path(dest_path, dest_dir)
           @utils.log("Copying #{source_path.inspect} from step #{input.step_name.inspect}")
-          copy_tree(step, source, dest, source_path)
+          copy_tree(step, source, dest, source_path, input.collisions)
         end
       end
 
@@ -540,7 +552,24 @@ module Toys
           source = ::File.expand_path(source_path, source_dir)
           dest = ::File.expand_path(dest_path, step.output_dir)
           @utils.log("Copying #{source_path.inspect} to output")
-          copy_tree(step, source, dest, source_path)
+          copy_tree(step, source, dest, source_path, output.collisions)
+        end
+      end
+
+      ##
+      # @private
+      # Handle a collision during copy_tree.
+      # Returns :keep or :replace
+      #
+      def handle_copy_collision(step, collisions, dest, src_name)
+        case collisions
+        when "keep"
+          :keep
+        when "replace"
+          ::FileUtils.remove_entry(dest)
+          :replace
+        else
+          step.abort_pipeline("Unable to copy #{src_name} because it already exists at the destination")
         end
       end
     end