reissue 0.4.13 → 0.4.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b4d46ca42d94ccf491e32974d657b0b799d1bc38dec50bfc422b324211c0dba
-  data.tar.gz: 0b9f9a2043e53cb0c534d1a2a96c9367a816fa44b49c6a6dce29586a6566ec8c
+  metadata.gz: d2dd0d8b9bc11f6c5b8f974bc0f0c0b561f2e879071e2aa00fe012a322d20e73
+  data.tar.gz: 0246c52e013c0309a7373b38f608bef56727e1265849e81898ea0b815b10db43
 SHA512:
-  metadata.gz: 543483500981a91880361b000cf9864c4ace92183d283ad25f0d849f574a5176e2c59349789c7e9852963d7513b790561012e7c42ebab8d69d2d81520ef520c5
-  data.tar.gz: c3c8da6ffbbe90a734b74c49922ec4acec0b1d1d9597ed3f496aee88336f932cb5fe8d631830abc6d131cefd10eaec61903696421f04c4935ed3428b23e615c3
+  metadata.gz: 7c678257f51a73f69708a38da1865dee98884d09619dd7f57a79541a05d40c5192206bafdb6fdbce12db4380e6c6428c2a6ac6c09a514888219426637572837d
+  data.tar.gz: 7cd5a57329c381a236edb74da800bd82f9ff21c59cc156c88f15789df3996aa81c0926a67840516f07327785b67acc67ec145d3f2eeeca7d82bda9f9db9baa4b

data/CHANGELOG.md

@@ -5,15 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.4.13] - 2026-02-10
+## [0.4.14] - 2026-02-11
 
 ### Added
 
-- Hoe plugin for integrating Reissue into Hoe-based projects (f5dde22)
-- Hoe plugin usage documentation in README and reissue:initialize task output (2bbd4ea)
-
-## [0.4.12] - 2026-02-09
+- Reissue.changelog_sections accessor with configurable, ordered section list (3da8a89)
+- changelog_sections option to Rake task and Hoe plugin (3da8a89)
 
 ### Changed
 
-- reissue:bump now reads Version trailers regardless of whether the version file matches the last tag (98905d6)
+- DirectoryFragmentHandler and GitFragmentHandler use centralized sections instead of their own constants (3da8a89)
+
+## [0.4.13] - 2026-02-10
+
+### Added
+
+- Hoe plugin for integrating Reissue into Hoe-based projects (f5dde22)
+- Hoe plugin usage documentation in README and reissue:initialize task output (2bbd4ea)

data/README.md

@@ -80,7 +80,7 @@ This hooks into Hoe's release lifecycle:
 - `prerelease` - Runs `reissue:bump` and `reissue:finalize` before release
 - `postrelease` - Runs `reissue` to bump version for the next development cycle
 
-All configuration options are available as `reissue_`-prefixed attributes (e.g., `reissue_version_file`, `reissue_changelog_file`). The version file defaults to `lib/#{name}/version.rb`.
+All configuration options are available as `reissue_`-prefixed attributes (e.g., `reissue_version_file`, `reissue_changelog_file`, `reissue_changelog_sections`). The version file defaults to `lib/#{name}/version.rb`.
 
 ### Non-Gem Projects
 
@@ -140,6 +140,11 @@ Reissue::Task.create :reissue do |task|
   # Note: Has no effect when using :git fragments
   task.clear_fragments = true
 
+  # Optional: Ordered list of valid changelog sections. Controls validation and display order.
+  # Defaults to: %w[Added Changed Deprecated Removed Fixed Security]
+  # Custom sections can be added; setting is idempotent (duplicates removed, names capitalized)
+  task.changelog_sections = %w[Major Added Changed Deprecated Removed Fixed Security]
+
   # Optional: Tag pattern for matching version tags. Defaults to /^v(\d+\.\d+\.\d+.*)$/
   # Must include a capture group for the version number.
   # Only applies when using :git fragments
@@ -193,7 +198,7 @@ Security: Rate limiting on login attempts"
 
 ### Supported Sections
 
-Git trailers use the standard Keep a Changelog sections:
+Git trailers use the standard [Keep a Changelog](http://keepachangelog.com/) sections by default:
 - `Added:` for new features
 - `Changed:` for changes in existing functionality
 - `Deprecated:` for soon-to-be removed features
@@ -201,6 +206,12 @@ Git trailers use the standard Keep a Changelog sections:
 - `Fixed:` for any bug fixes
 - `Security:` for vulnerability fixes
 
+You can customize the valid sections with `changelog_sections`. This controls both which trailer names are recognized and the order sections appear in the changelog:
+
+```ruby
+task.changelog_sections = %w[Major Added Changed Deprecated Removed Fixed Security]
+```
+
 ### How It Works
 
 1. When you run `rake reissue`, it finds all commits since the last version tag

data/lib/hoe/reissue.rb

@@ -7,6 +7,7 @@ module Hoe::Reissue
     :reissue_version_limit, :reissue_version_redo_proc,
     :reissue_fragment, :reissue_clear_fragments,
     :reissue_retain_changelogs, :reissue_tag_pattern,
+    :reissue_changelog_sections,
     :reissue_commit, :reissue_commit_finalize,
     :reissue_push_finalize, :reissue_push_reissue,
     :reissue_updated_paths
@@ -20,6 +21,7 @@ module Hoe::Reissue
     self.reissue_clear_fragments = false
     self.reissue_retain_changelogs = false
     self.reissue_tag_pattern = nil
+    self.reissue_changelog_sections = nil
     self.reissue_commit = true
     self.reissue_commit_finalize = true
     self.reissue_push_finalize = false
@@ -37,6 +39,7 @@ module Hoe::Reissue
       clear_fragments: reissue_clear_fragments,
       retain_changelogs: reissue_retain_changelogs,
       tag_pattern: reissue_tag_pattern,
+      changelog_sections: reissue_changelog_sections,
       commit: reissue_commit,
       commit_finalize: reissue_commit_finalize,
       push_finalize: reissue_push_finalize,

data/lib/reissue/fragment_handler/directory_fragment_handler.rb

@@ -5,15 +5,13 @@ require "pathname"
 module Reissue
   # Handler for reading fragments from a directory
   class DirectoryFragmentHandler < FragmentHandler
-    DEFAULT_VALID_SECTIONS = %w[added changed deprecated removed fixed security].freeze
-
     attr_reader :directory, :valid_sections
 
     # Initialize the handler with a directory path
     #
     # @param directory [String] The path to the fragments directory
     # @param valid_sections [Array<String>, nil] List of valid section names, or nil to allow all
-    def initialize(directory, valid_sections: DEFAULT_VALID_SECTIONS)
+    def initialize(directory, valid_sections: Reissue.changelog_sections)
       @directory = directory
       @fragment_directory = Pathname.new(directory)
       @valid_sections = valid_sections

data/lib/reissue/fragment_handler/git_fragment_handler.rb

@@ -4,12 +4,6 @@ module Reissue
   class FragmentHandler
     # Handles reading changelog entries from git commit trailers
     class GitFragmentHandler < FragmentHandler
-      # Valid changelog sections that can be used as trailers
-      VALID_SECTIONS = %w[Added Changed Deprecated Removed Fixed Security].freeze
-
-      # Regex to match changelog section trailers in commit messages
-      TRAILER_REGEX = /^(#{VALID_SECTIONS.join("|")}):\s*(.+)$/i
-
       # Default pattern for matching version tags (e.g., "v1.2.3")
       DEFAULT_TAG_PATTERN = /^v(\d+\.\d+\.\d+.*)$/
 
@@ -76,6 +70,10 @@ module Reissue
 
       private
 
+      def trailer_regex
+        /^(#{Reissue.changelog_sections.join("|")}):\s*(.+)$/io
+      end
+
       def git_available?
         system("git --version", out: File::NULL, err: File::NULL)
       end
@@ -161,7 +159,7 @@ module Reissue
             i += 1
             next if line.strip.empty?
 
-            if (match = line.match(TRAILER_REGEX))
+            if (match = line.match(trailer_regex))
               section_name = normalize_section_name(match[1])
               trailer_value = match[2].strip
 
@@ -170,7 +168,7 @@ module Reissue
                 next_line = lines[i].rstrip
                 # Stop at empty line or another changelog trailer
                 break if next_line.strip.empty?
-                break if next_line.match(TRAILER_REGEX)
+                break if next_line.match(trailer_regex)
 
                 trailer_value += " #{next_line.strip}"
                 i += 1

data/lib/reissue/rake.rb

@@ -107,6 +107,11 @@ module Reissue
     # Default: nil (uses default pattern matching "v1.2.3")
     attr_accessor :tag_pattern
 
+    # The ordered list of valid changelog sections.
+    # Controls both validation (which sections are accepted) and ordering (how they appear).
+    # Default: nil (uses Reissue.changelog_sections)
+    attr_accessor :changelog_sections
+
     def initialize(name = :reissue, formatter: Reissue, tasker: Rake::Task)
       @name = name
       @formatter = formatter
@@ -126,6 +131,7 @@ module Reissue
       @version_redo_proc = nil
       @push_reissue = :branch
       @tag_pattern = nil
+      @changelog_sections = nil
     end
 
     attr_reader :formatter, :tasker
@@ -184,6 +190,8 @@ module Reissue
     end
 
     def define
+      Reissue.changelog_sections = changelog_sections if changelog_sections
+
       desc description
       task name, [:segment] do |task, args|
         segment = args[:segment] || "patch"
@@ -314,9 +322,8 @@ module Reissue
             end
           else
             puts "Changelog entries that will be added:\n\n"
-            # Sort sections in Keep a Changelog order
-            section_order = %w[Added Changed Deprecated Removed Fixed Security]
-            sorted_sections = entries.keys.sort_by { |k| section_order.index(k) || 999 }
+            # Sort sections in configured changelog order
+            sorted_sections = entries.keys.sort_by { |k| Reissue.changelog_sections.index(k) || 999 }
 
             sorted_sections.each do |section|
               items = entries[section]
@@ -445,6 +452,9 @@ namespace :reissue do
         task.push_reissue = :branch               # Push strategy: false, true, or :branch
         task.push_finalize = false                # Push after finalize: false, true, or :branch
 
+        # Custom changelog sections (controls validation and ordering)
+        # task.changelog_sections = %w[Added Changed Deprecated Removed Fixed Security]
+
         # Custom tag pattern for version detection (must include capture group)
         # task.tag_pattern = /^myapp-v(\\d+\\.\\d+\\.\\d+.*)$/
       end

data/lib/reissue/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reissue
-  VERSION = "0.4.13"
+  VERSION = "0.4.14"
 end

data/lib/reissue.rb

@@ -7,6 +7,16 @@ require_relative "reissue/fragment_handler"
 
 # Reissue is a module that provides functionality for updating version numbers and changelogs.
 module Reissue
+  DEFAULT_CHANGELOG_SECTIONS = %w[Added Changed Deprecated Removed Fixed Security].freeze
+
+  def self.changelog_sections
+    @changelog_sections ||= DEFAULT_CHANGELOG_SECTIONS.dup
+  end
+
+  def self.changelog_sections=(sections)
+    @changelog_sections = Array(sections).map(&:capitalize).uniq
+  end
+
   # Updates the version number and changelog.
   #
   # @param version_file [String] The path to the version file.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.4.13
+  version: 0.4.14
 platform: ruby
 authors:
 - Jim Gay