kettle-changelog 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987f0528fbdee3c91c47d9675fe79fe3e4993f69c4b759ee7413a07c0b6eece9
-  data.tar.gz: d20d9e1fff2153b932cb3961d8bb56fd8bd02b0e9257b4b2844eaaa70ac7cb11
+  metadata.gz: 2ecd249c6b061cc317b81a854a766b92f0f8563ec986d46ba301c91aa0e03be9
+  data.tar.gz: 5aa44defac27dbce2d14a0b52f24647a700f9910980ab5dea0ed194586c2bb26
 SHA512:
-  metadata.gz: d379f0164efc1c4d7214607eb2e745895dce3cb5e0702da2d27d63f62f376ec077b842061e74d98a93ca4ad9015cc3200e4daf8ca73a3d9ba338e8bbb339fc61
-  data.tar.gz: 21ecb7793e5b0ebc36d2e0987419a3b9f900267ce04e1edabdfa18c5c3f3e72bc112d6456a95bdc2b8f79df77dc7cf58cd7b2057049aa90238ebd501d1796a8d
+  metadata.gz: 4f2695df4b42baf349133ce330e7e35ea80ec0060a7d50e6373249717cd171fdbbc50898f89dfdbfc2e5fab4d698bcc60b30512f170d0bccbd9bf33a5cd3c7d9
+  data.tar.gz: 85cc9764d62f271e046efec6730b491c0a124d78a52dea7732f4fd31f94ebb4bd2e2b8d994147d51b1fe92ccfdd20d3289cad70681ca1883a65d2a11ba3154c5

data/CHANGELOG.md

@@ -30,6 +30,32 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.0.7] - 2026-08-30
+
+- TAG: [v1.0.7][1.0.7t]
+- COVERAGE: 94.35% -- 1136/1204 lines in 6 files
+- BRANCH COVERAGE: 77.73% -- 398/512 branches in 6 files
+- 38.89% documented
+
+### Fixed
+
+- Honor the release-provided disposable lockfile when generating strict changelog coverage.
+
+- Use generated coverage bundles for changelog coverage when available, with explicit bundle selection overrides.
+
+## [1.0.6] - 2026-08-29
+
+- TAG: [v1.0.6][1.0.6t]
+- COVERAGE: 94.27% -- 1119/1187 lines in 6 files
+- BRANCH COVERAGE: 77.31% -- 385/498 branches in 6 files
+- 38.89% documented
+
+### Fixed
+
+- Consolidate repeated keyed project-file summaries when updating a prepared release section.
+
+- Consolidate repeated keyed project-file summaries within each published release during changelog reformatting.
+
 ## [1.0.5] - 2026-08-28
 
 - TAG: [v1.0.5][1.0.5t]
@@ -179,7 +205,11 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.5...HEAD
+[Unreleased]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.7...HEAD
+[1.0.7]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.6...v1.0.7
+[1.0.7t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.7
+[1.0.6]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.5...v1.0.6
+[1.0.6t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.6
 [1.0.5]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.4...v1.0.5
 [1.0.5t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.5
 [1.0.4]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.3...v1.0.4

data/README.md

@@ -123,6 +123,7 @@ gem install kettle-changelog
 
 - `K_CHANGELOG_PATH` selects a changelog outside the current project root.
 - `K_CHANGELOG_COVERAGE_ROOT` selects the project root used for coverage generation.
+- `K_CHANGELOG_COVERAGE_GEMFILE` selects the target-project Gemfile used for coverage generation. It is resolved relative to the coverage root; absent an explicit setting, `gemfiles/coverage.gemfile` is preferred when generated by Appraisal, then the root `Gemfile` is used.
 - `K_CHANGELOG_VERSION_FILE` selects the version file when the project has more than one version tree.
 - `K_CHANGELOG_GEM_NAME` overrides the gem name used for release lookups.
 - `K_CHANGELOG_STRICT=false` allows missing coverage or YARD data.
@@ -137,6 +138,10 @@ Run the release preparation command from the gem root:
 bundle exec kettle-changelog
 ```
 
+Use `--coverage-gemfile PATH` to select a different target-project coverage
+bundle for one invocation. This is intentionally separate from `BUNDLE_GEMFILE`,
+which may be required to run `kettle-changelog` itself from a release bundle.
+
 Use `--yes` for non-interactive release automation. Add a note without preparing a release with:
 
 ```console
@@ -397,7 +402,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.143-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.204-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: https://github.com/kettle-dev/kettle-changelog/blob/main/SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/exe/kettle-changelog

@@ -63,7 +63,7 @@ end
 
 if ARGV.include?("-h") || ARGV.include?("--help")
   puts <<~USAGE
-    Usage: kettle-changelog [--version VERSION] [--yes] [--update-prep|--reformat|--backfill-released-version VERSION] [--pending-release] [--release-state] [--refresh-cache] [--add-unreleased-entry --section SECTION --entry TEXT] [--upsert-unreleased-entry --section SECTION --key KEY --entry TEXT] [--json|--events[=TYPES]] [--no-strict] [--no-coverage-threshold]
+    Usage: kettle-changelog [--version VERSION] [--yes] [--coverage-gemfile PATH] [--update-prep|--reformat|--backfill-released-version VERSION] [--pending-release] [--release-state] [--refresh-cache] [--add-unreleased-entry --section SECTION --entry TEXT] [--upsert-unreleased-entry --section SECTION --key KEY --entry TEXT] [--json|--events[=TYPES]] [--no-strict] [--no-coverage-threshold]
 
     Detects the current version from lib/**/version.rb, the latest live release, and
     the most recent CHANGELOG.md release section, then prompts to confirm the selected plan:
@@ -93,12 +93,14 @@ if ARGV.include?("-h") || ARGV.include?("--help")
       --events[=TYPES]          Print newline-delimited JSON changelog events
       --no-strict               Allow missing coverage and yard data (warnings only, no errors)
       --no-coverage-threshold   Generate coverage without hard-failing below configured thresholds
+      --coverage-gemfile PATH   Run coverage through this target-project Gemfile
 
     Environment:
       K_CHANGELOG_STRICT=false              Disable strict mode (equivalent to --no-strict flag)
       K_CHANGELOG_COVERAGE_HARD=false       Disable coverage threshold hard-failure
       K_CHANGELOG_PATH=path                 Read and write this changelog instead of ./CHANGELOG.md
       K_CHANGELOG_COVERAGE_ROOT=path        Run/read coverage from this root instead of the gem root
+      K_CHANGELOG_COVERAGE_GEMFILE=path     Target-project Gemfile for coverage; defaults to gemfiles/coverage.gemfile, then Gemfile
       K_CHANGELOG_VERSION_FILE=path         Read VERSION from this file instead of lib/**/version.rb
       K_CHANGELOG_GEM_NAME=name             Read live release data as this gem instead of root .gemspec
       KETTLE_GEM_COOP_REFRESH=true          Bypass cached gem.coop version data
@@ -206,6 +208,7 @@ begin
   end
 
   historical_backfill_version = extract_option_arg!(ARGV, "--backfill-released-version")
+  coverage_gemfile = extract_option_arg!(ARGV, "--coverage-gemfile")
 
   if upsert_unreleased_entry
     section = extract_option_arg!(ARGV, "--section")
@@ -240,7 +243,7 @@ begin
   end
 
   event_stream = events_output ? Kettle::Ndjson.event_stream($stdout, types: event_types) : nil
-  cli = Kettle::Changelog::CLI.new(strict: strict_mode, enforce_coverage_thresholds: coverage_hard, update_prep: update_prep, reformat_only: reformat_only, historical_backfill_version: historical_backfill_version, version: version_override, refresh_cache: refresh_cache, yes: yes, event_stream: event_stream)
+  cli = Kettle::Changelog::CLI.new(strict: strict_mode, enforce_coverage_thresholds: coverage_hard, update_prep: update_prep, reformat_only: reformat_only, historical_backfill_version: historical_backfill_version, version: version_override, refresh_cache: refresh_cache, yes: yes, event_stream: event_stream, coverage_gemfile: coverage_gemfile)
   if release_state_query
     state = cli.release_state
     puts(json_output ? JSON.pretty_generate(state) : cli.release_state_table(state))

data/lib/kettle/changelog/cli.rb

@@ -35,10 +35,11 @@ module Kettle
       # @param historical_backfill_version [String, nil] tagged release to document without moving Unreleased entries
       # @param version [String, nil] explicit version override for gems without a literal VERSION constant
       # @param yes [Boolean] when true, approve the selected release plan without prompting
-      def initialize(strict: true, enforce_coverage_thresholds: true, update_prep: false, reformat_only: false, historical_backfill_version: nil, version: nil, root: Kettle::Dev::CIHelpers.project_root, refresh_cache: false, yes: false, event_stream: nil)
+      def initialize(strict: true, enforce_coverage_thresholds: true, update_prep: false, reformat_only: false, historical_backfill_version: nil, version: nil, root: Kettle::Dev::CIHelpers.project_root, refresh_cache: false, yes: false, event_stream: nil, coverage_gemfile: nil)
         @root = root
         @changelog_path = resolved_changelog_path
         @coverage_root = resolved_coverage_root
+        @coverage_gemfile = resolved_coverage_gemfile(coverage_gemfile)
         @coverage_path = File.join(@coverage_root, "coverage", "coverage.json")
         @strict = strict
         @enforce_coverage_thresholds = enforce_coverage_thresholds
@@ -425,6 +426,7 @@ module Kettle
         updated = convert_heading_tag_suffix_to_list(changelog)
         updated = normalize_legacy_release_headings(updated)
         updated = remove_redundant_historical_placeholders(updated)
+        updated = collapse_keyed_project_file_updates_by_release(updated)
         updated = normalize_heading_spacing(updated)
         updated = ensure_footer_spacing(updated)
         updated = updated.rstrip + "\n"
@@ -460,6 +462,15 @@ module Kettle
         lines.each_with_index.reject { |_line, index| removals.any? { |range| range.cover?(index) } }.map(&:first).join
       end
 
+      def collapse_keyed_project_file_updates_by_release(changelog)
+        lines = changelog.to_s.lines
+        changelog_release_sections(lines).sort_by { |section| section.fetch(:start) }.reverse_each do |section|
+          range = section.fetch(:start)...section.fetch(:finish)
+          lines[range] = KeyedEntryUpserter.collapse_project_file_updates(lines[range].join).lines
+        end
+        lines.join
+      end
+
       def changelog_release_sections(lines)
         headings = lines.each_index.filter_map do |index|
           match = lines[index].match(/^## \[(#{CHANGELOG_VERSION_PATTERN_SOURCE})\]/o)
@@ -710,7 +721,8 @@ module Kettle
           end
         end
 
-        ([leading] + sections.map { |section| section.fetch(:heading) + trim_blank_lines(section.fetch(:lines)).join }).join.rstrip + "\n"
+        merged = ([leading] + sections.map { |section| section.fetch(:heading) + trim_blank_lines(section.fetch(:lines)).join }).join.rstrip + "\n"
+        KeyedEntryUpserter.collapse_project_file_updates(merged)
       end
 
       def strip_release_metadata(release_body)
@@ -928,11 +940,42 @@ module Kettle
           env[key] = nil
         end
         env.merge!(changelog_coverage_workflow_thresholds)
-        gemfile = File.join(@coverage_root, "Gemfile")
-        env["BUNDLE_GEMFILE"] = gemfile if File.file?(gemfile)
+        env["BUNDLE_GEMFILE"] = @coverage_gemfile if @coverage_gemfile
+        coverage_lockfile = ENV.fetch("KETTLE_CHANGELOG_COVERAGE_LOCKFILE", "").to_s.strip
+        unless coverage_lockfile.empty?
+          raise "Configured changelog coverage lockfile does not exist: #{coverage_lockfile}" unless File.file?(coverage_lockfile)
+
+          env["BUNDLE_LOCKFILE"] = coverage_lockfile
+        end
+        # This is a release-tool handoff, not target-project configuration.
+        env["KETTLE_CHANGELOG_COVERAGE_LOCKFILE"] = nil
         env
       end
 
+      # Coverage has a deliberately smaller bundle than the project's normal
+      # development bundle when Appraisal generated gemfiles/coverage.gemfile.
+      # Keep the explicit setting separate from BUNDLE_GEMFILE: that variable
+      # commonly belongs to the outer kettle-changelog release bundle.
+      def resolved_coverage_gemfile(explicit_gemfile)
+        requested = explicit_gemfile.to_s.strip
+        requested = ENV.fetch("K_CHANGELOG_COVERAGE_GEMFILE", "").to_s.strip if requested.empty?
+
+        unless requested.empty?
+          path = File.expand_path(requested, @coverage_root)
+          raise "Configured changelog coverage Gemfile does not exist: #{path}" unless File.file?(path)
+
+          return path
+        end
+
+        generated = File.join(@coverage_root, "gemfiles", "coverage.gemfile")
+        return generated if File.file?(generated)
+
+        root_gemfile = File.join(@coverage_root, "Gemfile")
+        return root_gemfile if File.file?(root_gemfile)
+
+        nil
+      end
+
       # The changelog coverage run is the final local test gate before a
       # release commit is pushed. Reuse the checked-in CI workflow thresholds
       # rather than silently falling back to kettle-soup-cover defaults.

data/lib/kettle/changelog/keyed_entry_upserter.rb

@@ -5,6 +5,67 @@ module Kettle
     class KeyedEntryUpserter
       SECTIONS = %w[Added Changed Deprecated Removed Fixed Security].freeze
       KEY_PREFIX = "[kc]"
+      PROJECT_FILE_UPDATE_FIRST_LINE = /\A[-*]\s+\[kc\]\s+([^\s:]+):\s+updated\s+\d+\s+project\s+files?:\s*\z/
+      PROJECT_FILE_UPDATE_CATEGORY_LINE = /\A\s{2,}[-*]\s+(.+?)\s+\((\d+)\)\s*\z/
+
+      class << self
+        # Consolidates repeated maintenance summaries after a prepared release
+        # is updated in place. The AST supplies list-item boundaries; the two
+        # regular expressions only parse the stable text payload inside those
+        # already-classified Markdown items.
+        def collapse_project_file_updates(source)
+          require "ast/crispr/markdown/markly"
+          context = Ast::Crispr::Markdown::Markly.document_context(content: source.to_s, source_label: "CHANGELOG.md")
+          updates = context.structural_owners(owner_scope: :list_items)
+            .select { |item| item.depth == 1 }
+            .filter_map { |item| project_file_update_record(item) }
+          duplicate_groups = updates.group_by { |update| update.fetch(:key) }.values.select { |group| group.length > 1 }
+          return source.to_s if duplicate_groups.empty?
+
+          lines = source.to_s.lines
+          duplicate_groups.flatten.sort_by { |update| update.fetch(:start_line) }.reverse_each do |update|
+            group = duplicate_groups.find { |candidate| candidate.include?(update) }
+            first = group.min_by { |candidate| candidate.fetch(:start_line) }
+            replacement = (update == first) ? project_file_update_entry(group).lines : []
+            lines[(update.fetch(:start_line) - 1)...update.fetch(:end_line)] = replacement
+          end
+          lines.join
+        end
+
+        private
+
+        def project_file_update_record(item)
+          lines = item.source.to_s.lines
+          key_match = PROJECT_FILE_UPDATE_FIRST_LINE.match(lines.shift.to_s.strip)
+          return unless key_match
+
+          counts = lines.filter_map do |line|
+            match = PROJECT_FILE_UPDATE_CATEGORY_LINE.match(line)
+            next unless match
+
+            [match[1].tr(" ", "_").to_sym, match[2].to_i]
+          end.to_h
+          return if counts.empty?
+
+          {
+            key: key_match[1],
+            counts: counts,
+            start_line: item.location.start_line,
+            end_line: item.location.end_line
+          }
+        end
+
+        def project_file_update_entry(entries)
+          counts = entries.each_with_object(Hash.new(0)) do |entry, totals|
+            entry.fetch(:counts).each { |category, count| totals[category] += count }
+          end
+          total = counts.values.sum
+          details = counts.sort_by { |category, _count| category.to_s }.map do |category, count|
+            "  - #{category.to_s.tr("_", " ")} (#{count})"
+          end
+          ["- #{KEY_PREFIX} #{entries.first.fetch(:key)}: updated #{total} project file#{"s" unless total == 1}:", *details, ""].join("\n")
+        end
+      end
 
       def initialize(section:, key:, entry:, legacy_prefixes: [], root: Kettle::Dev::CIHelpers.project_root)
         @root = root

data/lib/kettle/changelog/version.rb

@@ -5,7 +5,7 @@ module Kettle
     # Version namespace for this gem.
     module Version
       # Current gem version.
-      VERSION = "1.0.5"
+      VERSION = "1.0.7"
     end
     # Current gem version exposed at the traditional constant location.
     VERSION = Version::VERSION # Traditional Constant Location

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Peter H. Boling
@@ -63,7 +63,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.15
+        version: 3.0.19
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
@@ -73,7 +73,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.15
+        version: 3.0.19
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
@@ -304,10 +304,10 @@ licenses:
 - AGPL-3.0-only
 metadata:
   homepage_uri: https://kettle-changelog.galtzo.com
-  source_code_uri: https://github.com/kettle-dev/kettle-changelog/tree/v1.0.5
-  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.5/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-dev/kettle-changelog/tree/v1.0.7
+  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.7/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-dev/kettle-changelog/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.5
+  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.7
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-dev/kettle-changelog/wiki
   news_uri: https://www.railsbling.com/tags/kettle-changelog