toys-release 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ff3cf2eca9706959eddfb418f6b32a26be0b6b38729060daf8eea59b328a22
-  data.tar.gz: 7859d5108f62f3cfe45107aaf737ca278866d07edab8d7cdf678ff9e5b6c5124
+  metadata.gz: '019248786a71a0bd4f1afc4eb48fd79ca81205ef43141619643bb59c2e0063a7'
+  data.tar.gz: 5e847ffe3fb7bf789cd66d102c5118886f417b3ed496cc010b5e5427e2b4387d
 SHA512:
-  metadata.gz: 794cd275768b4a657558527699cb1c5fd1ca628115cf144e30b9f4c2f4ac10ab939381203c1784cc5d92cfaa05c39f9c2999d799c9334140b64765989b7d9850
-  data.tar.gz: 18c092ffbfc0489fd064548778350bf22cc3cb2f436aa02bc23c9a4488879768dc3b875b92de8440306c8ef20142c148a46ee331e67e8983703c5efe7ed47fc1
+  metadata.gz: 8286d5ca56e71bbd76809b87c4bc5003fbce363b541f0f8e76d710a88f3e4fed0a10a1a5a19b2585b00dbdefb212dde034f9ac4b693a5642ef768c148dde961e
+  data.tar.gz: ac59da66c4d90fe5911a5ff18e50f38b04d9d88c6acb86abdd1fc45645c3a6d758b9c6979acd96ee11a0082abeb4403fbd93d9161fb4765fb98deb0023b59682

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Release History
 
+### v0.2.2 / 2025-11-30
+
+* FIXED: Fixed several crashes in the retry tool
+* FIXED: Fixed step cleaner trying to clean the .git directory on non-monorepos
+* FIXED: Repo prechecks can now actually stop releases from being performed
+* FIXED: Retry tool uses --work-dir= instead of --gh-pages-dir=
+* FIXED: Dry run mode no longer attempts to update pull requests or open issues
+
+### v0.2.1 / 2025-11-30
+
+* FIXED: Fixed some typos in the release pipeline logs
+* DOCS: Fixed minor typos in readme files
+
+### v0.2.0 / 2025-11-30
+
+* BREAKING CHANGE: Reworked pipeline design and normalized how steps communicate
+* BREAKING CHANGE: Removed defunct commit linter
+
 ### v0.1.1 / 2025-11-09
 
 * FIXED: The gen-gh-pages script now generates the correct redirect paths on a non-monorepo with the default directory structure

data/README.md

@@ -7,7 +7,7 @@ based on semantic versioning, and supports fine tuning and approval of releases
 using GitHub pull requests.
 
 Out of the box, Toys-Release knows how to tag GitHub releases, build and push
-gems to Rubygems, and build and publish documentation to gh-pages. You can also
+gems to RubyGems, and build and publish documentation to gh-pages. You can also
 customize the build pipeline and many aspects of its behavior.
 
 ## Description
@@ -62,11 +62,11 @@ by closing the pull request without merging.
 Toys-Release requires Ruby 2.7 or later, and Toys 0.17 or later. We recommend
 the latest version of the standard C implementation of Ruby. (JRuby or
 TruffleRuby _may_ work, but are unsupported.) The Ruby provided by the standard
-setup-ruby GitHub Action is sufficient.
+`setup-ruby` GitHub Action is sufficient.
 
 ## License
 
-Copyright 2019-2025 Daniel Azuma and the Toys contributors
+Copyright 2025 Daniel Azuma and the Toys contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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.2.2"
   end
 end

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

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
@@ -83,17 +83,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 +101,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 +112,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 +123,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 +136,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 +213,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 +228,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
@@ -338,10 +338,10 @@ module Toys
     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
+      # 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 gemspec file
       #

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

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
@@ -317,17 +303,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 +326,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