reissue 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b29a6f2ef60fb2fcd7c8a87473a6331b7761c6396f1274128821540f562ec06c
-  data.tar.gz: fd813df98ea7a642b4b65895db0155a5ba34100f65358fbd0fb65863fcb992d4
+  metadata.gz: d7a30f436a8c3bdf476c8ef3a7547536e292b3b81cf207ff8efe92404eacf2e9
+  data.tar.gz: 20d5e0d023af7778e0de3d71859088b5baa216bc00c7ef09a46732e1dcc0712a
 SHA512:
-  metadata.gz: ed99a9041e9ab54640c75d5eb5ff6dc86688a120069d8b5d9c866f0299c15c883bc4e7aecb7cd511c43e44dc4667d4f029e7cbab794ad84a4d45b9c43a7b8da7
-  data.tar.gz: f693b77d20a53cd92619efc3d3c984d93788b98caaac3d88a853bed175b8c7f589f8d4837196769dd8f9f6f7650a5c23dab1a956140c4bf774f5001df6b953d1
+  metadata.gz: fea5c4c4d7c7c4d7abcd43d038e9566de875892ee2cda0e95730f69c4108fd3a0304f99ec5ab3bcdd17b104719280b7610061973217eb9fc1277d265cb017238
+  data.tar.gz: 24a0fcfb969d6ba3640e3594a268cd192aa5b7316b49e88aa7059f918bfdb9fb0728aaf81df11cd3a61950ffea47af6c30d07725c12c6bdeac5ff742f08991e9

data/CHANGELOG.md

@@ -5,28 +5,24 @@ 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.2.0] - 2024-07-02
+## [0.2.2] - 2024-09-06
 
 ### Added
 
-- Reissue::Markdown class to implement the Reissue::Parser.parse behavior
-
-### Removed
-
-- Reissue::Parser implementation
+- Add a `reissue:branch` task to create a new branch for the next version
+- Add a `reissue:push` task to push the new branch to the remote repository
 
 ### Fixed
 
-- Handle multiline changes
+- Require the 'date' library in tests to ensure the Date constant is present
+- Ensure that `updated_paths` are always enumerable
 
-## [0.1.8] - Unreleased
-
-### Changed
+## [0.2.1] - 2024-07-29
 
-- Update the README.md to specify the default values for some configuration.
+### Added
 
-## [0.1.7] - 2024-06-10
+- Release notes and the checksum for the 0.2.0 version
 
-### Fixed
+### Changed
 
-- Pass the version_redo_proc to the Reissue.call in the reissue task.
+- Return the new version from the reissue task

data/README.md

@@ -52,6 +52,10 @@ This will add the following rake tasks:
   the latest version.
 - `rake reissue:reformat[version_limit]` - Reformat the CHANGELOG.md file and
   optionally limit the number of versions to maintain.
+- `rake reissue:branch[branch-name]` - Create a new branch for the next version.
+  Controlled by the `push_finalize` and `commit_finalize` options.
+- `rake reissue:push` - Push the changes to the remote repository. Controlled
+  by the `push_finalize` and `commit_finalize` options.
 
 This will also update the `build` task from rubygems to first run
 `reissue:finalize` and then build the gem, ensuring that your changelog is
@@ -105,6 +109,9 @@ Reissue::Task.create :your_name_and_namespace do |task|
 
   # Optional: Whether or not to commit the results of the finalize task. Defaults to true.
   task.commit_finalize = false
+
+  # Optional: Whether to push the changes automatically. Defaults to false.
+  task.push_finalize = :branch # or false, or true to push the working branch
 end
 ```
 
@@ -112,6 +119,15 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+## Releasing
+
+Run `rake build:checksum` to build the gem and generate the checksum. This will also update the version number in the gemspec file.
+
+Run `rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+This will leave a new commit with the version number incremented in the version file and the changelog updated with the new version.
+Push the changes to the repository.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/SOFware/reissue.

data/Rakefile

@@ -16,5 +16,5 @@ require_relative "lib/reissue/gem"
 
 Reissue::Task.create :reissue do |task|
   task.version_file = "lib/reissue/version.rb"
-  task.commit = true
+  task.push_finalize = :branch
 end

data/lib/reissue/printer.rb

@@ -28,7 +28,7 @@ module Reissue
         changes_string = changes.map do |section, section_changes|
           format_section(section, section_changes)
         end.join("\n\n")
-        [version_string, changes_string].filter_map { |str| str unless str.empty? }.join("\n\n")
+        [version_string, changes_string].reject { |str| str.empty? }.join("\n\n")
       end.then do |data|
         if data.empty?
           "## [0.0.0] - Unreleased"

data/lib/reissue/rake.rb

@@ -32,7 +32,11 @@ module Reissue
     attr_accessor :changelog_file
 
     # Additional paths to add to the commit.
-    attr_accessor :updated_paths
+    attr_writer :updated_paths
+
+    def updated_paths
+      Array(@updated_paths)
+    end
 
     # Whether to commit the changes. Default: true.
     attr_accessor :commit
@@ -40,6 +44,14 @@ module Reissue
     # Whether to commit the finalize change to the changelog. Default: true.
     attr_accessor :commit_finalize
 
+    # Whether to branch and push the changes. Default: :branch.
+    # Requires commit_finialize to be true.
+    #
+    # Set this to false to disable pushing.
+    # Set this to true to push to the current branch.
+    # Set this to :branch to push to a new branch.
+    attr_accessor :push_finalize
+
     def initialize(name = :reissue)
       @name = name
       @description = "Prepare the code for work on a new version."
@@ -48,10 +60,19 @@ module Reissue
       @changelog_file = "CHANGELOG.md"
       @commit = true
       @commit_finalize = true
+      @push_finalize = false
       @version_limit = 2
       @version_redo_proc = nil
     end
 
+    def finalize_with_branch?
+      push_finalize == :branch
+    end
+
+    def push_finalize?
+      !!push_finalize
+    end
+
     def define
       desc description
       task name, [:segment] do |task, args|
@@ -74,6 +95,8 @@ module Reissue
         else
           system("echo '#{bump_message}'")
         end
+
+        new_version
       end
 
       desc "Reformat the changelog file to ensure it is correctly formatted."
@@ -92,12 +115,25 @@ module Reissue
         version, date = Reissue.finalize(date, changelog_file:)
         finalize_message = "Finalize the changelog for version #{version} on #{date}"
         if commit_finalize
+          Rake::Task["#{name}:branch"].invoke("reissue/#{version}") if finalize_with_branch?
           system("git add -u")
           system("git commit -m '#{finalize_message}'")
+          Rake::Task["#{name}:push"].invoke if push_finalize?
         else
           system("echo '#{finalize_message}'")
         end
       end
+
+      desc "Create a new branch for the next version."
+      task "#{name}:branch", [:branch] do |task, args|
+        raise "No branch name specified" unless args[:branch]
+        system("git checkout -b #{args[:branch]}")
+      end
+
+      desc "Push the current branch to the remote repository."
+      task "#{name}:push" do
+        system("git push origin HEAD")
+      end
     end
   end
 end

data/lib/reissue/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reissue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake