toys-release 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7e7c3ea9f175113e9565cc7b9f017eff5de24c8366b946323203d86b6d1935d
-  data.tar.gz: '08c8a4a8f7d65c865fce847b7ad1ef8cdd47a840348c0deada8ead48dde96bf3'
+  metadata.gz: 760890033dfab6a454ca2364d28dc335c787576328b7899f11ce7886129bc820
+  data.tar.gz: 5c1c8178fd9313d1359c7c4044240c6be7cc0cc76911d2750eb1420b66bea185
 SHA512:
-  metadata.gz: bcec75c6c50f5415356ce4b329b4c04fbeff104f271d9fa56e4d6bf937743828d26e133ce2328294a20472de58130f92cf8cd364c995d3e933819c666137be1d
-  data.tar.gz: b8c669b5f75f25894f8489776f422c4cbb1c7453d77ba79d9aa2fb05a32ced2e94799b1fc480f4c89c7c89818b2c7334a3dc3e522bb91d5f862336365ed8724f
+  metadata.gz: b06f2e581a8474075ed3ea105935644c47a500ad7d0aadf0cd88f82ecf1464939cc5f4136c90fb30d8bfb5e7439dc4857fee1c2fc92296ab66e5b77b68079dda
+  data.tar.gz: d672e7c98230a13e14c33d9781b433f7f6cd12bf9e9ea6bc2fd55ce163401ed6a098ac6839cda3d8bebb7a79b60aa2a9532e75c401433337fb688b4492b2663d

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release History
 
+### v0.5.0 / 2026-01-27
+
+* BREAKING CHANGE: Disabled GitHub check validation by default, because GitHub started adding hidden checks we can't account for
+* ADDED: Support for updating release pull requests when new commits are added
+* ADDED: Multiple release pull requests are now allowed as long as they don't release any of the same components
+* FIXED: Use v6 of the checkout action
+* FIXED: Disabled GitHub check validation by default, because GitHub started adding hidden checks we can't account for
+* FIXED: Reverting a commit that itself does a revert does the right thing
+* FIXED: Fixed error when requesting a release from a branch with a slash in the name
+* FIXED: Updated some outdated GitHub API usage
+
+### v0.4.0 / 2026-01-06
+
+* ADDED: Actions workflows use Ruby 4.0 and Toys 0.19 or later
+* FIXED: Output formatting in setup utilities is more consistent
+
 ### v0.3.2 / 2025-12-25
 
 * DOCS: Some formatting fixes in the user guide

data/README.md

@@ -75,7 +75,7 @@ For more information on the underlying Toys framework, see the
 
 ## License
 
-Copyright 2025 Daniel Azuma and the Toys contributors
+Copyright 2025-2026 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/docs/guide.md

@@ -927,8 +927,8 @@ required. The rest are optional.
  *  **required_checks**: *regexp/boolean* (optional) --
     Identifies which GitHub checks must pass as a prerequisite for a release.
     If a string is provided, it is interpreted as a Ruby regexp (PCRE) and
-    identifies the check names. A boolean value of *true* (the default) means
-    all checks must pass. A boolean value of *false* disables checking.
+    identifies the check names. A boolean value of *true* means all checks must
+    pass. A boolean value of *false* (the default) disables checking.
 
  *  **required_checks_timeout**: *integer* (optional) --
     The time to wait, in seconds, for required checks to pass during release

data/lib/toys/release/version.rb

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

data/toys/.data/templates/release-hook-on-closed.yml.erb

@@ -13,7 +13,7 @@ jobs:
   release-process-request:
     if: ${{ github.repository == '<%= @settings.repo_path %>' }}
     env:
-      ruby_version: "3.4"
+      ruby_version: "4.0"
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
@@ -21,7 +21,7 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Install Toys
         run: "gem install --no-document toys"
       - name: Process release request

data/toys/.data/templates/release-hook-on-push.yml.erb

@@ -2,8 +2,8 @@ name: "[release hook] Update open releases"
 
 on:
   push:
-    branches:
-      - <%= @settings.main_branch %>
+    branches-ignore:
+      - "<%= @settings.release_branch_prefix %>/**"
 
 permissions:
   contents: write # required for pushing changes
@@ -13,7 +13,7 @@ jobs:
   release-update-open-requests:
     if: ${{ github.repository == '<%= @settings.repo_path %>' }}
     env:
-      ruby_version: "3.4"
+      ruby_version: "4.0"
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
@@ -21,7 +21,7 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Install Toys
         run: "gem install --no-document toys"
       - name: Update open releases

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

@@ -23,7 +23,7 @@ jobs:
   release-perform:
     if: ${{ github.repository == '<%= @settings.repo_path %>' }}
     env:
-      ruby_version: "3.4"
+      ruby_version: "4.0"
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
@@ -31,7 +31,7 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Install Toys
         run: "gem install --no-document toys"
       - name: Perform release

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

@@ -16,7 +16,7 @@ jobs:
   release-request:
     if: ${{ github.repository == '<%= @settings.repo_path %>' }}
     env:
-      ruby_version: "3.4"
+      ruby_version: "4.0"
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
@@ -24,7 +24,7 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Install Toys
         run: "gem install --no-document toys"
       - name: Open release pull request

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

@@ -20,7 +20,7 @@ jobs:
   release-retry:
     if: ${{ github.repository == '<%= @settings.repo_path %>' }}
     env:
-      ruby_version: "3.4"
+      ruby_version: "4.0"
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
@@ -28,7 +28,7 @@ jobs:
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
       - name: Install Toys
         run: "gem install --no-document toys"
       - name: Retry release

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

@@ -23,21 +23,21 @@ module Toys
         @semver = Semver::NONE
         @change_groups = nil
         @inputs = []
+        @significant_shas = nil
       end
 
       ##
       # Add a commit.
       #
-      # @param sha [String] The SHA for the commit.
-      # @param message [String] The commit message.
+      # @param commit [Toys::Release::CommitInfo] The commit.
       #
-      def add_message(sha, message)
+      def add_commit(commit)
         raise "ChangeSet locked" if finished?
-        lines = message.split("\n")
+        lines = commit.message.split("\n")
         return if lines.empty?
-        input = Input.new(sha)
+        input = Input.new(commit.sha)
         lines.each { |line| analyze_line(line, input) }
-        @inputs << input
+        @inputs << input if input.significant?
         self
       end
 
@@ -52,6 +52,7 @@ module Toys
         @commit_tags.each do |tag_info|
           tag_info.all_headers.each { |header| change_groups[header] = Group.new(header) }
         end
+        apply_reverts
         @inputs.each do |input|
           @semver = input.semver if input.semver > @semver
           input.changes.each do |(header, change)|
@@ -60,9 +61,10 @@ module Toys
           change_groups[:breaking].add(input.breaks)
         end
         @change_groups = change_groups.values.find_all { |group| !group.empty? }
-        if @change_groups.empty? && @semver != Semver::NONE
+        if @change_groups.empty? && @semver.significant?
           @change_groups << Group.new(nil).add(@no_significant_updates_notice)
         end
+        @significant_shas = @inputs.map(&:sha)
         @inputs = nil
         self
       end
@@ -88,12 +90,19 @@ module Toys
       end
 
       ##
-      # @return [boolean] Whether this change set is empty.
+      # @return [boolean] Whether this change set is empty. Valid only after
+      #     the change set is finished.
       #
       def empty?
-        @change_groups.empty?
+        @change_groups&.empty?
       end
 
+      ##
+      # @return [Array<String>] All significant SHAs. Valid only after the
+      #     change set is finished.
+      #
+      attr_reader :significant_shas
+
       ##
       # @return [Integer] The semver change.
       #
@@ -185,13 +194,22 @@ module Toys
         when /^semver-change$/i
           input.apply_semver_change(match[:content].split.first)
         when /^revert-commit$/i
-          @inputs.delete_if { |elem| elem.sha.start_with?(match[:content].split.first) }
+          input.add_revert(match[:content].split.first)
         else
           tag_info = @commit_tags.find { |tag| tag.tag == match[:tag] }
           input.apply_commit(tag_info, match[:scope], match[:bang], match[:content])
         end
       end
 
+      def apply_reverts
+        reverts = []
+        @inputs.reverse_each do |input|
+          next if reverts.any? { |revert_sha| input.sha.start_with?(revert_sha) }
+          reverts += input.reverts
+        end
+        @inputs.delete_if { |input| reverts.any? { |revert_sha| input.sha.start_with?(revert_sha) } }
+      end
+
       ##
       # @private
       # Analyzed commit info
@@ -204,6 +222,7 @@ module Toys
           @breaks = []
           @semver = Semver::NONE
           @semver_locked = false
+          @reverts = []
         end
 
         attr_reader :sha
@@ -211,6 +230,12 @@ module Toys
         attr_reader :breaks
         attr_reader :semver
         attr_reader :semver_locked
+        attr_reader :reverts
+
+        # @private
+        def significant?
+          @semver.significant? || !reverts.empty? || !changes.empty? || !breaks.empty?
+        end
 
         # @private
         def apply_breaking_change(value)
@@ -245,6 +270,11 @@ module Toys
           self
         end
 
+        # @private
+        def add_revert(sha)
+          @reverts << sha
+        end
+
         private
 
         def normalize_description(description, delete_pr_number: false)

data/toys/.lib/toys/release/commit_info.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Toys
+  module Release
+    ##
+    # Represents info about a commit
+    #
+    class CommitInfo
+      ##
+      # Create a new CommitInfo
+      #
+      # @param environment_utils [Toys::Release::EnvironmentUtils]
+      # @param sha [String]
+      #
+      def initialize(environment_utils, sha, message: nil)
+        @utils = environment_utils
+        @sha = sha
+        @message = message
+        @parent_sha = nil
+        @modified_paths = nil
+      end
+
+      ##
+      # @return [String] The SHA of this commit
+      #
+      attr_reader :sha
+
+      ##
+      # @return [boolean] Whether this commit is valid.
+      #
+      def exist?
+        !message.empty?
+      end
+
+      ##
+      # @return [String] The commit message, or the empty string if this commit
+      #     does not exist.
+      #
+      def message
+        @message ||= begin
+          git_cmd = ["git", "log", sha, "--max-count=1", "--format=%B"]
+          result = @utils.exec(git_cmd, out: :capture, err: :null)
+          result.success? ? result.captured_out.strip : ""
+        end
+      end
+
+      ##
+      # @return [String] The SHA of this commit's parent, for diffs, or the
+      #     empty string if this commit does not exist.
+      #
+      def parent_sha
+        @parent_sha ||=
+          if exist?
+            result = @utils.exec(["git", "rev-parse", "#{sha}^"], out: :capture, err: :null)
+            if result.success?
+              result.captured_out.strip
+            else
+              @utils.capture(["git", "hash-object", "-t", "tree", "--stdin"], e: true, in: :null).strip
+            end
+          else
+            ""
+          end
+      end
+
+      ##
+      # @return [Array<String>] A list of paths modified by this commit, or the
+      #     empty array if this commit does not exist.
+      #
+      def modified_paths
+        @modified_paths ||=
+          if exist?
+            git_cmd = ["git", "diff", "--name-only", "#{parent_sha}..#{sha}"]
+            @utils.capture(git_cmd, e: true).split("\n").sort
+          else
+            []
+          end
+      end
+    end
+  end
+end

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

@@ -13,13 +13,13 @@ module Toys
       ##
       # Constructor
       #
-      # @param repo_settings [Toys::Release::RepoSettings] the repo settings
+      # @param repository [Toys::Release::Repository] the repository
       # @param name [String] The component name
       # @param environment_utils [Toys::Release::EnvironmentUtils] env utils
       #
-      def initialize(repo_settings, name, environment_utils)
-        @repo_settings = repo_settings
-        @settings = repo_settings.component_settings(name)
+      def initialize(repository, name, environment_utils)
+        @repository = repository
+        @settings = repository.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)
@@ -245,23 +245,27 @@ module Toys
       end
 
       ##
-      # Returns a list of commit messages, since the given committish, that are
-      # relevant to this component.
+      # Returns a changeset with the changes, from the given commit range, that
+      # are relevant to this component.
       #
+      # @param commits [Array<Toys::Release::CommitInfo>,nil] Commits to add.
+      #     If not provided, uses `from` and `to` to get commits.
       # @param from [String,nil] The starting point, defaults to the last
-      #     release tag. Set to nil explicitly to use the first commit.
+      #     release tag. Set to nil explicitly to search the full history of
+      #     the `to` commit.
       # @param to [String] The endpoint. Defaults to HEAD.
-      # @return [ChangeSet]
       #
-      def make_change_set(from: :default, to: nil)
-        to ||= "HEAD"
-        from = latest_tag(ref: to) if from == :default
-        commits = from ? "#{from}..#{to}" : to
+      # @return [Toys::Release::ChangeSet]
+      #
+      def make_change_set(commits: nil, from: :default, to: nil)
+        commits ||= begin
+          to ||= "HEAD"
+          from = latest_tag(ref: to) if from == :default
+          @repository.commit_info_sequence(from: from, to: to)
+        end
         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)
-          changeset.add_message(sha, message) if message
+        commits.each do |commit|
+          changeset.add_commit(commit) if touched?(commit)
         end
         changeset.finish
       end
@@ -280,33 +284,20 @@ module Toys
       end
 
       ##
-      # Checks if the given sha touches this component. If so, returns the
-      # commit message, otherwise returns nil.
+      # Checks if the given commit touches this component.
       #
-      # @return [String] if the given commit touches this component
-      # @return [nil] if the given commit does not touch this component
+      # @param commit [Toys::Release::CommitInfo] A commit to check
+      # @return [boolean] Whether the given commit touches this component
       #
-      def touched_message(sha)
+      def touched?(commit)
         dir = settings.directory
         dir = "#{dir}/" unless dir.end_with?("/")
 
-        message = @utils.capture(["git", "log", sha, "--max-count=1", "--format=%B"], e: true)
-        return message if dir == "./" || /(^|\n)touch-component: #{name}(\s|$)/i.match?(message)
-
-        result = @utils.exec(["git", "rev-parse", "#{sha}^"], out: :capture, err: :null)
-        parent_sha =
-          if result.success?
-            result.captured_out.strip
-          else
-            @utils.capture(["git", "hash-object", "-t", "tree", "--stdin"], in: :null).strip
-          end
-        files = @utils.capture(["git", "diff", "--name-only", "#{parent_sha}..#{sha}"], e: true)
-        files.split("\n").each do |file|
-          return message if (file.start_with?(dir) ||
-                            settings.include_globs.any? { |pattern| ::File.fnmatch?(pattern, file) }) &&
-                            settings.exclude_globs.none? { |pattern| ::File.fnmatch?(pattern, file) }
+        return true if dir == "./" || /(^|\n)touch-component: #{name}(\s|$)/i.match?(commit.message)
+        commit.modified_paths.any? do |file|
+          (file.start_with?(dir) || settings.include_globs.any? { |pattern| ::File.fnmatch?(pattern, file) }) &&
+            settings.exclude_globs.none? { |pattern| ::File.fnmatch?(pattern, file) }
         end
-        nil
       end
 
       # @private

data/toys/.lib/toys/release/pull_request.rb

@@ -106,31 +106,88 @@ module Toys
         resource["merged_at"] ? true : false
       end
 
+      ##
+      # @return [String] The pull request description text
+      #
+      def description
+        resource["body"].to_s
+      end
+
+      ##
+      # Attempt to parse metadata from the pull request description.
+      #
+      # @return [Hash,nil] The metadata hash, or nil if not found.
+      #
+      def release_metadata
+        unless defined?(@release_metadata)
+          match = /```\n# release_metadata(?:\s[^\n]*)?\n(\{\n(?:[^\n]*\n)+\}\n)```\n/.match(description)
+          @release_metadata = begin
+            match ? ::JSON.parse(match[1]) : nil
+          rescue ::JSON::ParserError
+            nil
+          end
+        end
+        @release_metadata
+      end
+
+      ##
+      # The request components hash from the release metadata.
+      #
+      # @return [Hash{String=>(String,nil)},nil] The arguments, or nil if not found.
+      #
+      def requested_components
+        metadata = release_metadata
+        metadata ? metadata["requested_components"] : nil
+      end
+
+      ##
+      # The request sha from the release metadata.
+      #
+      # @return [String,nil] The SHA, or nil if not found
+      #
+      def release_request_sha
+        metadata = release_metadata
+        metadata ? metadata["request_sha"] : nil
+      end
+
       ##
       # Perform various updates to a pull request
       #
       # @param labels [String,Array<String>,nil] One or more release-related
       #     labels that should be applied. All existing release-related labels
-      #     are replaced with this list. Optional; no label updates are applied
-      #     if not present.
-      # @param state [String,nil] New pull request state. Optional; the state is
-      #     not modified if not present.
+      #     are replaced with this list. Optional; if not present, no label
+      #     updates are applied.
+      # @param state [String,nil] New pull request state. Optional; if not
+      #     present, the state is not modified.
+      # @param title [String,nil] New pull request title. Optional; if not
+      #     present, the title is not modified.
+      # @param body [String,nil] New pull request body. Optional; if not
+      #     present, the body is not modified.
       # @return [self]
       #
-      def update(labels: nil, state: nil)
-        body = {}
-        body[:state] = state if state && self.state != state
+      def update(labels: nil, state: nil, title: nil, body: nil)
+        content = {}
+        content[:state] = state if state && self.state != state
+        content[:body] = body if body
+        content[:title] = title if title
         if labels
           labels = Array(labels)
           release_labels, other_labels = self.labels.partition do |label|
             repository.release_related_label?(label)
           end
-          body[:labels] = other_labels + labels unless release_labels.sort == labels.sort
+          content[:labels] = other_labels + labels unless release_labels.sort == labels.sort
         end
-        unless body.empty?
-          cmd = ["gh", "api", "-XPATCH", "repos/#{repository.settings.repo_path}/issues/#{number}",
-                 "--input", "-", "-H", "Accept: application/vnd.github.v3+json"]
-          repository.utils.exec(cmd, in: [:string, ::JSON.dump(body)], out: :null, e: true)
+        unless content.empty?
+          cmd = [
+            "gh", "api",
+            "--method", "PATCH",
+            "repos/#{repository.settings.repo_path}/issues/#{number}",
+            "-H", "Accept: application/vnd.github+json",
+            "-H", "X-GitHub-Api-Version: 2022-11-28",
+            "--input", "-"
+          ]
+          # TODO: Update the resource in this object
+          repository.utils.exec(cmd, in: [:string, ::JSON.dump(content)], out: :null, e: true)
         end
         self
       end
@@ -142,9 +199,16 @@ module Toys
       # @return [self]
       #
       def add_comment(message)
-        cmd = ["gh", "api", "repos/#{repository.settings.repo_path}/issues/#{number}/comments",
-               "--input", "-", "-H", "Accept: application/vnd.github.v3+json"]
-        repository.utils.exec(cmd, in: [:string, ::JSON.dump(body: message)], out: :null, e: true)
+        content = {body: message}
+        cmd = [
+          "gh", "api",
+          "--method", "POST",
+          "repos/#{repository.settings.repo_path}/issues/#{number}/comments",
+          "-H", "Accept: application/vnd.github+json",
+          "-H", "X-GitHub-Api-Version: 2022-11-28",
+          "--input", "-"
+        ]
+        repository.utils.exec(cmd, in: [:string, ::JSON.dump(content)], out: :null, e: true)
         self
       end
     end

data/toys/.lib/toys/release/repo_settings.rb

@@ -644,6 +644,11 @@ module Toys
       #
       attr_reader :gh_pages_enabled
 
+      ##
+      # @return [boolean] Whether commits update existing release requests
+      #
+      attr_reader :update_existing_requests
+
       ##
       # @return [Array<CommitTagSettings>] The conventional commit types
       #     recognized as release-triggering, along with information on the
@@ -926,6 +931,7 @@ module Toys
         @signoff_commits = info.delete("signoff_commits") ? true : false
         @gh_pages_enabled = info.delete("gh_pages_enabled") ? true : false
         @enable_release_automation = info.delete("enable_release_automation") != false
+        @update_existing_requests = info.delete("update_existing_requests") ? true : false
         @release_branch_prefix = info.delete("release_branch_prefix") || "release"
         @git_user_name = info.delete("git_user_name")
         @git_user_email = info.delete("git_user_email")
@@ -935,7 +941,7 @@ module Toys
         required_checks = info.delete("required_checks")
         @required_checks_regexp =
           case required_checks
-          when false
+          when false, nil
             nil
           when true
             //