Merge pull request #17 from SOFware/bug/fix-finalize

Fix finalize to retain changelogs

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [0.3.3] - Unreleased
 
+### Fixed
+
+- Properly retain changelog on `reissue:finalize`
+
 ## [0.3.2] - 2025-01-16
 
 ### Fixed

lib/reissue.rb

@@ -41,9 +41,9 @@ def self.call(
   # @param changelog_file [String] The path to the changelog file.
   #
   # @return [Array] The version number and release date.
-  def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md")
+  def self.finalize(date = Date.today, changelog_file: "CHANGELOG.md", retain_changelogs: false)
     changelog_updater = ChangelogUpdater.new(changelog_file)
-    changelog = changelog_updater.finalize(date:, changelog_file:)
+    changelog = changelog_updater.finalize(date:, changelog_file:, retain_changelogs:)
     changelog["versions"].first.slice("version", "date").values
   end
 

lib/reissue/rake.rb

@@ -148,7 +148,7 @@ def define
       desc "Finalize the changelog for an unreleased version to set the release date."
       task "#{name}:finalize", [:date] do |task, args|
         date = args[:date] || Time.now.strftime("%Y-%m-%d")
-        version, date = formatter.finalize(date, changelog_file:)
+        version, date = formatter.finalize(date, changelog_file:, retain_changelogs:)
         finalize_message = "Finalize the changelog for version #{version} on #{date}"
         if commit_finalize
           tasker["#{name}:branch"].invoke("reissue/#{version}") if finalize_with_branch?

test/test_reissue.rb

@@ -93,6 +93,16 @@ class TestReissue < Minitest::Spec
       assert_equal("0.1.2", version)
       assert_equal("2021-01-01", date)
     end
+
+    it "retains changelog history when specified" do
+      fixture_changelog = File.expand_path("fixtures/changelog.md", __dir__)
+      tempdir = Dir.mktmpdir
+      changelog_file = Tempfile.new
+      changelog_file << File.read(fixture_changelog)
+      changelog_file.close
+      Reissue.finalize("2021-01-01", changelog_file: changelog_file.path, retain_changelogs: tempdir)
+      assert File.exist?(File.join(tempdir, "0.1.2.md"))
+    end
   end
 
   describe ".reformat" do