net-ssh 8.0.1 → 8.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b548f463639f7a9a85eca15cc065ab99d7b3c803330733198f311eb46cbc3c13
-  data.tar.gz: 56dd051e3ff6346e4f5684c571d1136978314762b2eb2a248af00666c4ab136f
+  metadata.gz: db558d490e7fb5d8ca959a00ddd5a07d6c24bdc3957a8dcbb067848466928072
+  data.tar.gz: 91a1983ea97a6c94cd542c8dd55cbc0c46f99f2926d7fd168f027a90a404b693
 SHA512:
-  metadata.gz: f2d469ea5e169da065852011e64ecc4c30168baac60f4b241014ec1b7c1d76512e95163f726858f94cbaf722578fd0acddacfd446f31d4dfb65faafd62c97f1d
-  data.tar.gz: 3582df1af6a3686ff510d86268730c6eecb5104ddcc239cfe31c324940b3a57d6522fe74c1b8cde2e42385167ee57958c669284032d39eda947ddfa1b8fc6c43
+  metadata.gz: e154b5ec3ae2c1ac272e638ba3e7e51715f738ccb926a7dc2cf73ffea3819a6a39a1f08cd5b92ff6b403bd43383c400ff2b6817000f566240baedb2384419c70
+  data.tar.gz: 064a69e61d1bc28b22116fd6c26efd3339404527aa6e3a796ddca85b8eaee4aeb8d9b76c2a80f3bad0c1289436f35aaad403cb55dee2d74cd3d104764a0af0bb

data/.github/workflows/changelog.yml

@@ -9,35 +9,10 @@ permissions:
 
 jobs:
   changelog:
-    if: ${{ github.event.pull_request.user.login != 'dependabot[bot]' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
         with:
           # HEAD is the PR merged into the base branch; HEAD^1 is the base it was merged into.
           fetch-depth: 2
-      - name: Set up Ruby 3.1
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.1
-      - name: Validate fragments
-        run: rake changelog:check
-      - name: Require a fragment
-        if: ${{ !contains(github.event.pull_request.labels.*.name, 'skip-changelog') }}
-        env:
-          PR: ${{ github.event.number }}
-        run: |
-          changed=$(git diff --name-only HEAD^1 HEAD)
-          if echo "$changed" | grep -x 'CHANGES\.txt' > /dev/null; then
-            echo "::error::Don't edit CHANGES.txt, add a changelog.d/$PR.<type>.txt fragment instead, see CONTRIBUTING.md#changelog"
-            exit 1
-          fi
-          own=$(git diff --name-only --diff-filter=AMR HEAD^1 HEAD -- changelog.d/ | grep -E "^changelog\.d/$PR\.[a-z-]+(\.[0-9]+)?\.txt$" || true)
-          if [ -n "$own" ]; then
-            echo "Changelog fragments:"; echo "$own"
-          elif ! echo "$changed" | grep -v '^changelog\.d/' > /dev/null; then
-            echo "Only changelog.d/ changed, no fragment needed"
-          else
-            echo "::error::Add a changelog fragment named changelog.d/$PR.<type>.txt (use $PR.none.txt if nothing user-visible changed), see CONTRIBUTING.md#changelog"
-            exit 1
-          fi
+      - uses: net-ssh/changelogd@v1

data/.rubocop.yml

@@ -20,3 +20,7 @@ Layout/LineLength:
 
 Style/EmptyLiteral:
   Enabled: false
+
+# CI runs the suite with RUBYOPT=--enable=frozen-string-literal instead of a magic comment in every file.
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.rubocop_todo.yml

@@ -587,13 +587,6 @@ Style/FormatString:
     - 'lib/net/ssh/authentication/pageant.rb'
     - 'lib/net/ssh/loggable.rb'
 
-# Offense count: 174
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 1
 # This cop supports safe auto-correction (--auto-correct).
 Style/GlobalStdStream:

data/CHANGES.txt

@@ -1,6 +1,14 @@
+=== 8.0.3
+
+  * Add `preopen_channels` option: keep a spare session channel open so each command saves a round trip [#1071]
+
+=== 8.0.2
+
+  * Fixed `Session#close` raising `EOFError: cannot send data if channel has declared eof` when a forwarded connection still had unread data from its local client; data net-ssh had already read is still sent before the EOF and, as in OpenSSH, the rest is dropped; a regression in 8.0.0 [#1066, #1067]
+
 === 8.0.1
 
-  * Fixed `unexpected packet type 94 during initial key exchange` (or 93) when channel data arrives during a client-initiated re-key, which broke bulk transfers at the first re-key (e.g. with `rekey_limit`, or after about 1 GB); a regression in 8.0.0 [#1063]
+  * Fixed `unexpected packet type 94 during initial key exchange` (or 93) when channel data arrives during a client-initiated re-key, which broke bulk transfers at the first re-key (e.g. with `rekey_limit`, or after about 1 GB); a regression in 7.3.5 and 8.0.0 [#1063]
   * `control_master: :auto` now ignores `forward_agent` (logged at info level) instead of raising ArgumentError, and logs the ignored connection options at info instead of warn level, so it works with sshkit (Kamal, Capistrano), which always passes `forward_agent: true`, `keys`, `known_hosts` and `keepalive` [#1062]
 
 === 8.0.0

data/CONTRIBUTING.md

@@ -6,7 +6,7 @@ Run the unit tests with `bundle exec rake test` and the linter with `bundle exec
 
 Don't edit `CHANGES.txt`. Instead, add a fragment file to `changelog.d/` in your PR; the release's version bump (`rake vbump:*`) moves all fragments into a new `=== <version>` section at the top of `CHANGES.txt` and deletes them.
 
-A fragment is named `<number>.<type>.txt`, where `<number>` is the PR number (so open the PR first, then add the fragment), and contains a single UTF-8 paragraph: the entry as it should read in `CHANGES.txt`, without the bullet or prefix. Lines are joined, so it can be wrapped. If it doesn't end with a reference list such as `[#985, #1056]`, `[GHSA-xxxx-xxxx-xxxx]` or `[CVE-2024-12345, #1060]`, ` [#<number>]` is appended; write the list yourself to reference issues or advisories too.
+A fragment is named `<number>.<type>.txt`, where `<number>` is the PR number (so open the PR first, then add the fragment), and contains a single UTF-8 paragraph: the entry as it should read in `CHANGES.txt`, without the bullet or prefix. Lines are joined, so it can be wrapped. If it doesn't end with a reference list such as `[#985, #1056]` or `[GHSA-xxxx-xxxx-xxxx]`, ` [#<number>]` is appended.
 
 | Type                | Written as                     | Use for                                                      |
 | ------------------- | ------------------------------ | ------------------------------------------------------------ |
@@ -24,12 +24,11 @@ rake "changelog:new[1058,change,Session#exec! now returns the exit status]"
 
 echo 'Removed the `:paranoid` option; use `:verify_host_key` [#1050]' > changelog.d/1050.breaking.txt
 echo 'Reject packet lengths above 256 KB, as OpenSSH does [GHSA-pfqh-p9vh-wx4p]' > changelog.d/1060.security.txt
-echo 'Custom verifiers must implement `verify_signature` [#1050]' > changelog.d/1050.breaking-security.txt
 touch changelog.d/1061.none.txt
 ```
 
 For several entries from one PR add a suffix: `1050.breaking.txt`, `1050.breaking.2.txt` (`changelog:new` picks the next free one).
 
-In a release section, entries are grouped as `BREAKING: Security:`, `BREAKING:`, `Security:`, then the rest; within a group fragments are ordered by number, newest first, followed by any hand-written entries from an `=== Unreleased` section in their written order. A final release with nothing to report still gets a `=== <version>` section saying `No changes since <previous version>.`
+`rake changelog:check` validates the fragments and `rake changelog:preview` prints the section the next release would add. CI fails a PR that edits `CHANGES.txt` or doesn't add or modify a `changelog.d/<PR number>.<type>.txt` fragment, unless it only touches `changelog.d/` or a maintainer adds the `skip-changelog` label; Dependabot PRs are skipped.
 
-`rake changelog:check` validates the fragments and the `=== Unreleased` section, and `rake changelog:preview` prints the section the next release would add. CI fails a PR that edits `CHANGES.txt` or doesn't add or modify a `changelog.d/<PR number>.<type>.txt` fragment, unless it only touches `changelog.d/` or a maintainer adds the `skip-changelog` label; Dependabot PRs are skipped.
+The full rules, including how a release orders the entries, are in the [changelogd README](https://github.com/net-ssh/changelogd#readme).

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in mygem.gemspec
 gemspec
 
+gem "changelogd", git: "https://github.com/net-ssh/changelogd.git", tag: "v1", group: :development
+
 gem 'byebug', group: %i[development test] if !Gem.win_platform? && RUBY_ENGINE == "ruby"
 
 if ENV["CI"]

data/Rakefile

@@ -28,9 +28,18 @@ CLEAN.include ['pkg', 'rdoc']
 name = "net-ssh"
 
 require_relative "lib/net/ssh/version"
-require_relative "rakelib/changelog"
 version = Net::SSH::Version::CURRENT
 
+begin
+  require "changelogd/rake"
+rescue LoadError
+  # A git gem isn't on the load path under plain `rake`, as the release workflow runs it; bundler/setup could clash with the running rake.
+  require "bundler"
+  $LOAD_PATH.unshift(*Bundler.definition.specs["changelogd"].flat_map(&:full_require_paths))
+  require "changelogd/rake"
+end
+Changelogd::RakeTasks.new(version_file: "lib/net/ssh/version.rb")
+
 extra_files = %w[LICENSE.txt THANKS.txt CHANGES.txt]
 if defined?(RDoc::Task)
   RDoc::Task.new do |rdoc|
@@ -63,6 +72,7 @@ namespace :cert do
 end
 
 def change_version(&block)
+  Rake::Task["changelog:check"].invoke
   version_file = 'lib/net/ssh/version.rb'
   require_relative version_file
   pre = Net::SSH::Version::PRE
@@ -110,17 +120,9 @@ def change_version(&block)
     raise ArgumentError, "Cound not find line: TINY = \"#{tiny}\" in #{version_file}" unless found[:tiny] || new_tiny == tiny
   end
 
-  begin
-    heading = Changelog.heading(Net::SSH::Version::MAJOR, Net::SSH::Version::MINOR, new_tiny, new_pre)
-    section = Changelog.new(__dir__).release(heading)
-  rescue StandardError
-    FileUtils.rm_f "#{version_file}.new"
-    raise
-  end
-  puts section ? "Added to CHANGES.txt:\n#{section}" : "Nothing to release for a pre-release, CHANGES.txt unchanged"
-
   FileUtils.mv version_file, "#{version_file}.old"
   FileUtils.mv "#{version_file}.new", version_file
+  Rake::Task["changelog:release"].invoke
 end
 
 namespace :vbump do
@@ -158,44 +160,6 @@ namespace :vbump do
   end
 end
 
-namespace :changelog do
-  changelog = Changelog.new(__dir__)
-
-  desc "Validate the fragments in changelog.d/"
-  task :check do
-    count = changelog.check.size
-    puts "#{count} valid changelog fragment#{'s' unless count == 1}"
-  rescue Changelog::Error => e
-    abort e.message
-  end
-
-  desc "Print the CHANGES.txt section the next version bump would write"
-  task :preview, [:heading] do |_t, args|
-    puts changelog.section(args[:heading] || "Unreleased") || "Nothing to release"
-  rescue Changelog::Error => e
-    abort e.message
-  end
-
-  desc "Create a fragment: rake \"changelog:new[1234,change,Text of the entry]\""
-  task :new, [:number, :type] do |_t, args|
-    abort "Usage: rake \"changelog:new[<PR number>,<#{Changelog::TYPES.keys.join('|')}>,<text>]\"" unless args[:number] && args[:type]
-    # Rake splits arguments on commas and strips the spaces around them, so take the text from the raw task string.
-    raw = Rake.application.top_level_tasks.find { |t| t.start_with?("changelog:new[") }
-    text = raw&.[](/\A[^\[]*\[[^,]*,[^,]*,\s*(.*)\]\z/m, 1) || args.extras.join(", ")
-    puts "Created #{changelog.new_fragment(args[:number], args[:type], text)}"
-  rescue Changelog::Error => e
-    abort e.message
-  end
-
-  desc "Write the fragments to CHANGES.txt under a heading, e.g. rake \"changelog:release[7.3.4]\" (vbump does this)"
-  task :release, [:heading] do |_t, args|
-    abort "Usage: rake \"changelog:release[<version heading>]\"" unless args[:heading]
-    puts changelog.release(args[:heading]) || "Nothing to release"
-  rescue Changelog::Error => e
-    abort e.message
-  end
-end
-
 namespace :rdoc do
   desc "Update gh-pages branch"
   task :publish do

data/lib/net/ssh/connection/session.rb

@@ -53,6 +53,10 @@ module Net
         # The list of callbacks for pending requests. See #send_global_request.
         attr_reader :pending_requests # :nodoc:
 
+        # A "session" channel opened ahead of time by :preopen_channels, and
+        # the server's confirmation for it once that has arrived.
+        SpareChannel = Struct.new(:local_id, :remote_id, :window_size, :packet_size) # :nodoc:
+
         class NilChannel
           def initialize(session)
             @session = session
@@ -84,6 +88,11 @@ module Net
           @max_pkt_size = (options.key?(:max_pkt_size) ? options[:max_pkt_size] : 0x8000)
           @max_win_size = (options.key?(:max_win_size) ? options[:max_win_size] : Channel::DEFAULT_MAX_WIN_SIZE)
 
+          @preopen_channels = options.fetch(:preopen_channels, false)
+          @spare_channel = nil
+          @spare_wanted = false
+          @preopened = []
+
           @keepalive = Keepalive.new(self)
 
           @event_loop = options[:event_loop] || SingleSessionEventLoop.new
@@ -121,6 +130,7 @@ module Net
         # successfully closed, and then closes the underlying transport layer
         # connection.
         def close
+          stop_preopening
           info { "closing remaining channels (#{channels.length} open)" }
 
           channels.each do |id, channel|
@@ -143,6 +153,7 @@ module Net
         # when the connection needs to close but you don't know the status of the
         # underlying protocol's state).
         def shutdown!
+          stop_preopening
           transport.shutdown!
         end
 
@@ -258,8 +269,10 @@ module Net
         # Called by event loop to process available data before going to
         # event multiplexing
         def ev_preprocess(&block)
+          confirm_preopened_channels
           dispatch_incoming_packets(raise_disconnect_errors: false)
           each_channel { |id, channel| channel.process unless channel.local_closed? }
+          open_spare_channel
         end
 
         # Returns the file descriptors the event loop should wait for read/write events,
@@ -348,14 +361,20 @@ module Net
         #   end
         #
         #   channel.wait
+        #
+        # With the :preopen_channels option a plain "session" channel reuses
+        # the spare opened ahead of time, if there is one. Its callback still
+        # runs from the event loop, as if the server had just confirmed it.
         def open_channel(type = "session", *extra, &on_confirm)
-          local_id = get_next_channel_id
+          spare = take_spare_channel if type == "session" && extra.empty?
+          local_id = spare ? spare.local_id : get_next_channel_id
 
           channel = Channel.new(self, type, local_id, @max_pkt_size, @max_win_size, &on_confirm)
-          msg = Buffer.from(:byte, CHANNEL_OPEN, :string, type, :long, local_id,
-                            :long, channel.local_maximum_window_size,
-                            :long, channel.local_maximum_packet_size, *extra)
-          send_message(msg)
+          if spare
+            @preopened << [channel, spare] if spare.remote_id
+          else
+            send_channel_open(type, channel.local_id, channel.local_maximum_window_size, channel.local_maximum_packet_size, *extra)
+          end
 
           channels[local_id] = channel
         end
@@ -603,6 +622,8 @@ module Net
         end
 
         def force_channel_cleanup_on_close
+          stop_preopening
+          @preopened.clear
           channels.each do |id, channel|
             channel_closed(channel)
           end
@@ -694,18 +715,37 @@ module Net
 
         def channel_open_confirmation(packet)
           info { "channel_open_confirmation: #{packet[:local_id]} #{packet[:remote_id]} #{packet[:window_size]} #{packet[:packet_size]}" }
+          if (spare = spare_channel(packet))
+            spare.remote_id = packet[:remote_id]
+            spare.window_size = packet[:window_size]
+            spare.packet_size = packet[:packet_size]
+            return
+          end
+
           channel = channels[packet[:local_id]]
           channel.do_open_confirmation(packet[:remote_id], packet[:window_size], packet[:packet_size])
         end
 
         def channel_open_failure(packet)
           error { "channel_open_failed: #{packet[:local_id]} #{packet[:reason_code]} #{packet[:description]}" }
+          if spare_channel(packet)
+            info { "preopen_channels: server refused the spare channel, no longer pre-opening" }
+            stop_preopening
+            @spare_channel = nil
+            return
+          end
+
           channel = channels.delete(packet[:local_id])
           channel.do_open_failed(packet[:reason_code], packet[:description])
         end
 
         def channel_window_adjust(packet)
           info { "channel_window_adjust: #{packet[:local_id]} +#{packet[:extra_bytes]}" }
+          if (spare = spare_channel(packet))
+            spare.window_size += packet[:extra_bytes]
+            return
+          end
+
           channels[packet[:local_id]].do_window_adjust(packet[:extra_bytes])
         end
 
@@ -726,11 +766,20 @@ module Net
 
         def channel_eof(packet)
           info { "channel_eof: #{packet[:local_id]}" }
+          return if spare_channel(packet)
+
           channels[packet[:local_id]].do_eof
         end
 
         def channel_close(packet)
           info { "channel_close: #{packet[:local_id]}" }
+          if (spare = spare_channel(packet))
+            send_message(Buffer.from(:byte, CHANNEL_CLOSE, :long, spare.remote_id))
+            @spare_channel = nil
+            # Wait for the next plain open_channel before opening another, so a server closing spares can't make us loop.
+            @spare_wanted = false
+            return
+          end
 
           channel = channels[packet[:local_id]]
           channel_closed(channel)
@@ -746,6 +795,45 @@ module Net
           channels[packet[:local_id]].do_failure
         end
 
+        def send_channel_open(type, local_id, window_size, packet_size, *extra)
+          send_message(Buffer.from(:byte, CHANNEL_OPEN, :string, type, :long, local_id,
+                                   :long, window_size, :long, packet_size, *extra))
+        end
+
+        def take_spare_channel
+          return unless @preopen_channels
+
+          @spare_wanted = true
+          spare = @spare_channel
+          @spare_channel = nil
+          spare
+        end
+
+        def open_spare_channel
+          return unless @spare_wanted && @preopen_channels && @spare_channel.nil? && !closed?
+
+          @spare_channel = SpareChannel.new(get_next_channel_id)
+          info { "preopen_channels: opening spare channel #{@spare_channel.local_id}" }
+          send_channel_open("session", @spare_channel.local_id, @max_win_size, @max_pkt_size)
+        end
+
+        # An unused spare is never closed, as that would cost round trips just before the transport goes away;
+        # it stays in @spare_channel to absorb the server's late replies for it.
+        def stop_preopening
+          @preopen_channels = false
+        end
+
+        def confirm_preopened_channels
+          until @preopened.empty?
+            channel, spare = @preopened.shift
+            channel.do_open_confirmation(spare.remote_id, spare.window_size, spare.packet_size)
+          end
+        end
+
+        def spare_channel(packet)
+          @spare_channel if @spare_channel && @spare_channel.local_id == packet[:local_id]
+        end
+
         def io_select_wait(wait)
           [wait, max_select_wait_time].compact.min
         end

data/lib/net/ssh/service/forward.rb

@@ -346,6 +346,10 @@ module Net
               ch.info { "#{type} forwarded connection closed" }
               session.stop_listening_to(socket)
               ch.close
+            elsif ch.eof?
+              # Like OpenSSH's chan_shutdown_read: data already read still goes out before CHANNEL_EOF, the rest is dropped.
+              ch.output.append(socket.read_available) if socket.available > 0
+              session.pause_reading(socket)
             else
               if socket.available > 0
                 data = socket.read_available(8192)
@@ -376,6 +380,8 @@ module Net
           end
 
           channel.on_process do |ch|
+            next if ch.eof?
+
             data = ch[:socket].read(8192)
             if data
               ch.debug { "read #{data.length} bytes from client, sending over #{type} forwarded connection" }

data/lib/net/ssh/version.rb

@@ -52,7 +52,7 @@ module Net
       MINOR = 0
 
       # The tiny component of this version of the Net::SSH library
-      TINY  = 1
+      TINY  = 3
 
       # The prerelease component of this version of the Net::SSH library
       # nil allowed

data/lib/net/ssh.rb

@@ -71,7 +71,7 @@ module Net
       append_all_supported_algorithms non_interactive password_prompt
       agent_socket_factory minimum_dh_bits verify_host_key
       fingerprint_hash check_host_ip pubkey_algorithms no_delay
-      control_master control_path
+      control_master control_path preopen_channels
     ]
 
     # The standard means of starting a new SSH connection. When used with a
@@ -221,6 +221,12 @@ module Net
     #   is +nil+, for no passphrase)
     # * :password => the password to use to login
     # * :port => the port to use when connecting to the remote host
+    # * :preopen_channels => set to +true+ to keep one spare "session" channel
+    #   open, so that Net::SSH::Connection::Session#open_channel can hand it
+    #   out at once and a command that waits for the previous one to finish
+    #   costs one round trip instead of two. The spare counts against the
+    #   server's MaxSessions; if the server refuses it, pre-opening stops for
+    #   the session. Defaults to +false+.
     # * :properties => a hash of key/value pairs to add to the new connection's
     #   properties (see Net::SSH::Connection::Session#properties)
     # * :proxy => a proxy instance (see Proxy) to use when connecting

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.0.3
 platform: ruby
 authors:
 - Jamis Buck
@@ -32,7 +32,7 @@ cert_chain:
   ufHf4AX2UIkJbh7zCPkiNCqIr7MSWLNFG/9lOlHYsEJM8XujT1ofPobYx6YSFx/C
   7HBrI7UX7awt6UvBZebhcHzyMHxg/B5PVQllPA==
   -----END CERTIFICATE-----
-date: 2026-10-21 00:00:00.000000000 Z
+date: 2026-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -324,7 +324,6 @@ files:
 - lib/net/ssh/version.rb
 - net-ssh-public_cert.pem
 - net-ssh.gemspec
-- rakelib/changelog.rb
 - support/ssh_tunnel_bug.rb
 homepage: https://github.com/net-ssh/net-ssh
 licenses:

data/rakelib/changelog.rb

@@ -1,229 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'open3'
-
-# Builds CHANGES.txt sections from the fragment files in changelog.d/ (see CONTRIBUTING.md).
-class Changelog
-  class Error < StandardError; end
-
-  # Output order of the groups in a release section; `none` fragments are never emitted.
-  TYPES = {
-    'breaking-security' => 'BREAKING: Security: ',
-    'breaking' => 'BREAKING: ',
-    'security' => 'Security: ',
-    'change' => '',
-    'none' => nil
-  }.freeze
-
-  FILENAME = /\A(?<number>[1-9]\d*)\.(?<type>[a-z-]+)(?:\.(?<seq>[1-9]\d*))?\.txt\z/.freeze
-  REF = /#\d+|GHSA(?:-[a-z0-9]{4}){3}|CVE-\d{4}-\d+/i.freeze
-  REF_LIST = /\[(?:#{REF})(?:,\s*(?:#{REF}))*\]\z/.freeze
-  UNRELEASED = '=== Unreleased'
-  PLACEHOLDER = 'TODO: describe the change as it should read in CHANGES.txt'
-
-  Fragment = Struct.new(:path, :number, :type, :seq, :text) do
-    def entry
-      "#{TYPES.fetch(type)}#{text}"
-    end
-
-    def sort_key
-      [-number, seq]
-    end
-  end
-
-  attr_reader :dir, :changes_path
-
-  def initialize(root)
-    @root = root
-    @dir = File.join(root, 'changelog.d')
-    @changes_path = File.join(root, 'CHANGES.txt')
-  end
-
-  # Raises Error listing every invalid fragment; returns all fragments, including `none` ones.
-  def fragments
-    errors = []
-    fragments = []
-    entries_in_dir.each do |name|
-      result = parse_fragment(name)
-      result.is_a?(Fragment) ? fragments << result : errors << "changelog.d/#{name}: #{result}"
-    end
-    raise Error, "Invalid changelog fragments:\n  #{errors.join("\n  ")}" unless errors.empty?
-
-    fragments.sort_by(&:sort_key)
-  end
-
-  # Validates the fragments and the `=== Unreleased` section of CHANGES.txt; returns the fragments.
-  def check
-    all = fragments
-    split_changes(read_changes)
-    all
-  end
-
-  # The text of the section for +heading+, or nil for a pre-release with nothing to release.
-  def section(heading)
-    assemble(heading, fragments, split_changes(read_changes))
-  end
-
-  # Writes the section for +heading+ to the top of CHANGES.txt, folding in any `=== Unreleased`
-  # entries, and removes all fragments; returns the section, or nil when CHANGES.txt was left unchanged.
-  def release(heading)
-    all = fragments
-    content = read_changes
-    raise Error, "CHANGES.txt already has a '=== #{heading}' section" if content.lines.any? { |l| l.chomp == "=== #{heading}" }
-
-    parts = split_changes(content)
-    section = assemble(heading, all, parts)
-    if section
-      rest = parts[:rest].empty? ? '' : "\n#{parts[:rest]}"
-      File.write(changes_path, "#{parts[:preamble]}#{section}#{rest}")
-    end
-    remove(all.map(&:path))
-    section
-  end
-
-  # Creates a fragment for PR +number+ and returns its path; picks the next free `.N` suffix if needed.
-  def new_fragment(number, type, text = nil)
-    path = (1..).lazy.map { |seq| File.join(dir, fragment_name(number, type, seq)) }.find { |p| !File.exist?(p) }
-    error = validate_name(File.basename(path))
-    raise Error, error if error
-
-    FileUtils.mkdir_p(dir)
-    text = PLACEHOLDER if (text.nil? || text.strip.empty?) && type != 'none'
-    File.write(path, "#{text}\n")
-    path
-  end
-
-  def self.heading(major, minor, tiny, pre)
-    ["#{major}.#{minor}.#{tiny}", pre].compact.join(' ')
-  end
-
-  private
-
-  def entries_in_dir
-    return [] unless Dir.exist?(dir)
-
-    Dir.children(dir).sort.reject { |name| name == 'README.md' || name.start_with?('.') }
-  end
-
-  def fragment_name(number, type, seq)
-    seq == 1 ? "#{number}.#{type}.txt" : "#{number}.#{type}.#{seq}.txt"
-  end
-
-  def validate_name(name)
-    match = FILENAME.match(name)
-    return "file name must be <PR number>.<type>[.<n>].txt, types: #{TYPES.keys.join(', ')}" unless match
-    return "unknown type '#{match[:type]}', expected one of: #{TYPES.keys.join(', ')}" unless TYPES.key?(match[:type])
-
-    nil
-  end
-
-  # Returns a Fragment, or an error message.
-  def parse_fragment(name)
-    path = File.join(dir, name)
-    return 'is not a file' unless File.file?(path)
-
-    error = validate_name(name)
-    return error if error
-
-    match = FILENAME.match(name)
-    fragment = Fragment.new(path, match[:number].to_i, match[:type], (match[:seq] || 1).to_i, nil)
-    return fragment if fragment.type == 'none'
-
-    text = parse_text(read_utf8(path))
-    return text[:error] if text[:error]
-
-    fragment.text = text[:text]
-    fragment.text = "#{fragment.text} [##{fragment.number}]" unless fragment.text.match?(REF_LIST)
-    fragment
-  end
-
-  def parse_text(raw)
-    return { error: 'is not valid UTF-8' } unless raw.valid_encoding?
-
-    lines = raw.strip.lines.map(&:strip)
-    return { error: 'is empty' } if lines.empty?
-    return { error: 'must be a single paragraph (no blank lines)' } if lines.include?('')
-
-    text = lines.join(' ')
-    return { error: 'still contains the placeholder text' } if text == PLACEHOLDER
-    return { error: "should not start with a bullet, it's added when assembling" } if text.match?(/\A[*-] /)
-    return { error: 'should not start with BREAKING:/Security:, the type adds the prefix' } if text.match?(/\A(BREAKING|Security):/i)
-
-    { text: text }
-  end
-
-  def read_changes
-    File.exist?(changes_path) ? read_utf8(changes_path).gsub("\r\n", "\n") : ''
-  end
-
-  # Explicit so a non-UTF-8 locale (e.g. LANG=C) doesn't break on non-ASCII text.
-  def read_utf8(path)
-    File.read(path, mode: 'r:bom|utf-8')
-  end
-
-  # A final release (a heading without a pre-release suffix) always gets a section, so every published version has a heading.
-  def assemble(heading, fragments, parts)
-    entries = grouped_entries(fragments, parts[:unreleased])
-    if entries.empty?
-      return nil unless heading.match?(/\A\d+\.\d+\.\d+\z/)
-
-      previous = parts[:rest][/\A=== (.+)$/, 1]
-      entries = ["  * #{previous ? "No changes since #{previous}." : 'No changes.'}\n"]
-    end
-    "=== #{heading}\n\n#{entries.join}"
-  end
-
-  # Splits CHANGES.txt into the text before the first heading, the entries of a leading
-  # `=== Unreleased` section (as lists of raw lines) and everything from the first released heading on.
-  def split_changes(content)
-    lines = content.lines
-    first = lines.index { |l| l.start_with?('=== ') } || lines.size
-    preamble = lines[0...first].join
-    return { preamble: preamble, unreleased: [], rest: lines[first..].join } unless lines[first]&.chomp == UNRELEASED
-
-    body_end = lines.index.with_index { |l, i| i > first && l.start_with?('=== ') } || lines.size
-    { preamble: preamble, unreleased: unreleased_entries(lines[(first + 1)...body_end]), rest: lines[body_end..].join }
-  end
-
-  def unreleased_entries(lines)
-    lines.each_with_object([]) do |line, entries|
-      next if line.strip.empty?
-
-      if line.match?(/\A\s*\* /)
-        entries << [line]
-      elsif entries.empty?
-        raise Error, "Cannot parse the Unreleased section of CHANGES.txt near: #{line.strip}"
-      else
-        entries.last << line
-      end
-    end
-  end
-
-  # Fragments come before the hand-written Unreleased entries of the same group.
-  def grouped_entries(fragments, unreleased)
-    TYPES.keys.flat_map do |type|
-      from_fragments = fragments.select { |f| f.type == type && type != 'none' }.map { |f| "  * #{f.entry}\n" }
-      from_unreleased = unreleased.select { |lines| unreleased_type(lines.first) == type }.map do |lines|
-        lines.join.end_with?("\n") ? lines.join : "#{lines.join}\n"
-      end
-      from_fragments + from_unreleased
-    end
-  end
-
-  def unreleased_type(line)
-    text = line.sub(/\A\s*\* /, '')
-    TYPES.find { |_type, prefix| prefix && !prefix.empty? && text.start_with?(prefix) }&.first || 'change'
-  end
-
-  # `git rm` so the deletions are staged with the version bump; plain delete outside a git checkout.
-  def remove(paths)
-    return if paths.empty?
-
-    relative = paths.map { |p| p.delete_prefix("#{@root}/") }
-    _out, status = Open3.capture2e('git', '-C', @root, 'rm', '-q', '--', *relative)
-    FileUtils.rm_f(paths) unless status.success?
-  rescue SystemCallError
-    FileUtils.rm_f(paths)
-  end
-end