release-notes 3.1.0 → 4.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ffa78423d6770331d46c798c4f671984bca8fd896f4ca3238b304163c323b93
-  data.tar.gz: d64dcf45b0ce332cf57f04796f20a9d133d0f1330733fef796942033d87358c0
+  metadata.gz: 49daa419cb2bdfedfabbc46ebeca75fc652d578e7f998578b0d23ea56774f1fe
+  data.tar.gz: 89d93e9ff6270daccf930ae5726b4f6e4cfee434d86ccac17798faf99d69d8fe
 SHA512:
-  metadata.gz: 5b97056a68f3aacb0cac39b4a38889f90faf97eb55682487db95ab40873d2351def8e793855d17448627c9e7a1fb5d9af0778b9b8828e2b4a0bd35dce2edfe63
-  data.tar.gz: bfe153fcfc21253aaa4ce136099ddadc2d7e9f44462a24d99c36d74ce243a2bd921410e532fb4f2179b2e12d7b7d44700f97b16cccf4d15eb69c94cc78c1346a
+  metadata.gz: f207807fbf4170880c6d2a098a0153345f1e99f5a889fd76ea045e0e30684215be09aceeaeced121e9e3054a293b9b7b0672d257d9601944957ee5e504d0fd9b
+  data.tar.gz: 6b9f2670203e27019a0df4459b041aab6d3eaaa4db501a8d6713a1e74de598fe3d7858919b9146a5615a0efb9925463af662f14bde1f0437a055649da60d3042

data/.github/ISSUE_TEMPLATE.md

@@ -5,7 +5,6 @@ Put a brief summary here
 ## Environment
 
 - Ruby **[version]**
-- Rails **[version]**
 - release-notes **[version]**
 
 ## Current behavior

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -9,12 +9,5 @@ Fixes # (issue)
 ## Checklist
 
 - [ ] My code follows the style guidelines of this project
-- [ ] I have rebased the branch with the latest code from master
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas, and at the top of new interactors
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] The build is passing
-
-## Screenshots (if applicable)
-
-## Dependencies introduced

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Release Notes
 
+## v4.0.0.pre
+
+**Implemented enhancements:**
+
+- Update README remove git workflow recomendations for now
+- Add in new Release::Notes::Cmd
+- Add in predicate methods for Configuration
+
+**Fixed bugs:**
+
+- Fix cops
+- Remove backslash for linked labels
+- Remove rake task. Just support binstub usage
+- Fix up github templates
+
+**Miscellaneous:**
+
+- Another README update
+- Update README and template in generator
+
+## v3.1.0
+
+**Implemented enhancements:**
+
+- Add configurable option for format when grabbing git tags
+
 ## v3.0.0
 
 **Implemented enhancements:**

data/README.md

@@ -63,38 +63,144 @@ $ bundle exec rake release:notes:install
 Override any of these defaults in `config/initializers/release_notes.rb`:
 
 ```ruby
+# frozen_string_literal: true
+
 Release::Notes.configure do |config|
-  config.output_file = './RELEASE_NOTES.md'
-  config.temp_file = './release-notes.tmp.md'
+  # The absolute path of your generated log.
+  # Defaults to `./RELEASE_NOTES.md`.
+  # @return [String]
+  config.output_file = "./RELEASE_NOTES.md"
+
+  # The absolute path of the temporary generated log.
+  # Defaults to `./release-notes.tmp.md`.
+  # @return [String]
+  config.temp_file = "./release-notes.tmp.md"
+
+  # Determines whether to print commits with more than one parent.
+  # Defaults to `false`. For more, see
+  # [Git Log Docs](https://git-scm.com/docs/git-log)
+  # @return [Boolean]
   config.include_merges = false
+
+  # Match the regular expression limiting patterns without regard to letter case
+  # when printing your git log.
+  # Defaults to `true`. For more, see
+  # [Git Log Docs](https://git-scm.com/docs/git-log)
+  # @return [Boolean]
   config.ignore_case = true
+
+  # Consider the limiting patterns to be extended regular expressions patterns
+  # when printing your git log.
+  # Defaults to `true`. For more, see
+  # [Git Log Docs](https://git-scm.com/docs/git-log)
+  # @return [Boolean]
   config.extended_regex = true
+
+  # Controls the header used in your generated log for all tags.
+  # "tag" and "date" are the two valid options
+  # Defaults to `tag`.
+  # @return [String]
   config.header_title = "tag"
+
+  # Allows you to specify what information you want to print from your git log
+  # Defaults to `%s` for subject. For more, see
+  # [Git Log Docs](https://git-scm.com/docs/git-log)
+  # @return [String]
   config.bug_labels = %w(Fix Update)
+
+  # Controls the labels grepped for in your commit subjects that will
+  # be add under you feature title
+  # Defaults to `%w(Add Create)`.
+  # @return [Array]
   config.feature_labels = %w(Add Create)
+
+  # Controls the labels grepped for in your commit subjects that will
+  # be add under you miscellaneous title
+  # Defaults to `%w(Refactor)`.
+  # @return [Array]
   config.misc_labels = %w(Refactor)
-  config.bug_title = '**Fixed bugs:**'
-  config.feature_title = '**Implemented enhancements:**'
-  config.misc_title = '**Miscellaneous:**'
-  config.log_all_title = '**Other:**'
+
+  # Controls the title used in your generated log for all bugs listed
+  # Defaults to `**Fixed bugs:**`.
+  # @return [String]
+  config.bug_title = "**Fixed bugs:**"
+
+  # Controls the title used in your generated log for all features listed
+  # Defaults to `**Implemented enhancements:**`.
+  # @return [String]
+  config.feature_title = "**Implemented enhancements:**"
+
+  # Controls the title used in your generated log for all misc commits listed
+  # Defaults to `**Miscellaneous:**`.
+  # @return [String]
+  config.misc_title = "**Miscellaneous:**"
+
+  # Controls the title used in your generated log for all commits listed
+  # Defaults to `**Other:**`.
+  # @return [String]
+  config.log_all_title = "**Other:**"
+
+  # Controls whether all logs that do not match the other labels are listed
+  # Defaults to `false`
+  # @return [Boolean]
   config.log_all = false
+
+  # The labels grepped for in your commit subject that you want to linkify.
+  # The index within the array must match the index for the site
+  # in `:link_to_humanize` and `:link_to_sites`.
+  # Defaults to `[]`.
+  # @return [Array]
   config.link_to_labels = %w()
+
+  # The humanized output that you'd like to represent the associated `:link_to_label`
+  # The index within the array must match the index for the site
+  # in `:link_to_label` and `:link_to_sites`.
+  # Defaults to `[]`.
+  # @return [Array]
   config.link_to_humanize = %w()
+
+  # The url for the site that you'd like to represent the associated `:link_to_label`
+  # The index within the array must match the index for the site
+  # in `:link_to_label` and `:link_to_humanize`.
+  # Defaults to `[]`.
+  # @return [Array]
   config.link_to_sites = %w()
-  config.timezone = 'America/New_York'
+
+  # Sets the timezone that should be used for setting the date.
+  # Defaults to `America/New_York`. For more, see
+  # [ActiveSupport Time Zones](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
+  # @return [String]
+  config.timezone = "America/New_York"
+
+  # Controls whether your commit subject labels should be removed from the final
+  # ouput of your message on the generated log.
+  # Defaults to `false`.
+  # @return [Boolean]
   config.prettify_messages = false
-  config.force_rewrite = false
+
+  # If a commit message contains words that match more than
+  # one group of labels as defined in your configuration, the output
+  # will only contain the commit once.
+  # Defaults to `true`.
+  # @return [Boolean]
   config.single_label = true
+
+  # Controls what will be passed to the format flag in `git for-each-ref`
+  # Defaults to `tag`.
+  # @return [String]
+  config.for_each_ref_format = "tag"
+
+  # Determines whether to use the last two tags to
+  # find commits for the output or if this gem should just
+  # find all commits after previous tag
+  # Defaults to `true`.
+  # @return [Boolean]
+  config.update_release_notes_before_tag = true
 end
 ```
 
-For more information about each individual setting checkout Release::Notes's
-[config docs](https://www.rubydoc.info/gems/release-notes).
-
 ## Usage
 
-### TL;DR
-
 Install the binstub
 
 ```sh
@@ -104,62 +210,19 @@ $ bundle binstubs release-notes
 and run
 
 ```sh
-$ bin/release-notes
+# make sure to pass your tag if updating before you've pushed the latest tag
+$ bin/release-notes -t v0.2.0
+# OR if running for the first time on a project that might have commits after the latest tag
+$ bin/release-notes --ignore-head
+# OR if using an output file that already exists in a project but would like to rerun all git tags
+$ bin/release-notes --force-rewrite
 ```
 
-OR, just use the rake task
-
-```sh
-$ bundle exec rake update_release_notes:run
-```
-
-### Git Worklow
-
-Release::Notes works best with a rebase workflow and requires tagging. General rebase benefits include:
-
-- One clear commit per feature, bug or miscellaneous addition to the codebase
-- Commits in logical time manner
-
-By default configuration, Release::Notes ignores merges. Along with rebasing, by deafult,
-Release::Notes relies mainly on the subject of a commit. Therefore, it's important to craft concise and
-meaningful commit subjects with longer bodies as needed for larger feature additions or bug fixes.
-
-For more information about a rebase workflow or crafting solid commit messages
-check out the following links
-
-- [Commit Messages](http://chris.beams.io/posts/git-commit/)
-- [Git Rebase Workflow](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
-
-### Deploying with Capistrano
-
-A sample capistrano rake task might look like:
-
-```ruby
-# config/deploy/production.rb
-namespace :deploy do
-  before :starting, :update_release_notes
-
-  task :update_release_notes do
-    # use the binstub
-    sh 'bin/release-notes"'
-
-    # Then check in your release notes with a commit
-    sh "git commit -am 'Release to production #{Time.zone.now}'"
-    sh "git push origin master"
-  end
-end
-```
-
-Useful information can be found here regarding the
-[capistrano flow](http://capistranorb.com/documentation/getting-started/flow/).
-
-**From there, make sure you tag your releases**
-
-## Note
+## Important Notes
 
 - Your project must tag releases(release-notes uses the tag date to output the changes)
   (PR's to make this more flexible are welcome)
-- Linking is opinionated and will link to a URI structure of `#{site-url}/#{issue_number}`. It
+- Linking is opinionated and will link to a URI structure of `#{site-url}#{issue_number}`. It
   will ouput something like: `[HONEYBADGER #33150353](https://app.honeybadger.io/projects/9999/faults/33150353)`.
   This also means that your link_to_labels have to be something like `['HB #']` (PR's to make this more flexible are welcome)
 

data/bin/publish

@@ -48,10 +48,12 @@ FileUtils.chdir APP_ROOT do
     end
   FILE
 
-
   puts "== Updating version to #{current_version.join('.')} =="
   File.write("lib/release/notes/version.rb", contents)
 
+  puts "== Release Notes =="
+  system! "exe/release-notes generate -t #{current_version.join('.')}"
+
   puts "== Adding Changed Files =="
   system! "git add ."
 
@@ -60,16 +62,4 @@ FileUtils.chdir APP_ROOT do
 
   puts "== Tagging release =="
   system! "bundle exec rake release"
-
-  puts "== Release Notes =="
-  system! "exe/release-notes"
-
-  puts "== Adding updated CHANGELOG =="
-  system! "git add CHANGELOG.md"
-
-  puts "== Committing updated files =="
-  system! "git commit -m 'Modify CHANGELOG.md'"
-
-  puts "== Pushing updated files =="
-  system! "git push origin master"
-end
+end

data/exe/release-notes

@@ -12,9 +12,7 @@ file = File.exist?(rails_config_file) ? rails_config_file : config_file
 
 begin
   require file
-  warn "=> Generating release notes..."
-  Release::Notes.generate
-  warn "=> Done!"
+  Release::Notes::Cmd.start(ARGV)
 rescue LoadError
   warn "=> Missing release_notes.rb configuration file"
 rescue SignalException => e

data/lib/generators/release/notes/install/templates/release_notes.rb

@@ -113,15 +113,22 @@ Release::Notes.configure do |config|
   # @return [Boolean]
   # config.prettify_messages = false
 
-  # Controls whether to rewrite the output file or append to it.
-  # Defaults to `false`.
-  # @return [Boolean]
-  # config.force_rewrite = false
-
   # If a commit message contains words that match more than
   # one group of labels as defined in your configuration, the output
   # will only contain the commit once.
   # Defaults to `true`.
   # @return [Boolean]
-  # attr_accessor :single_label
+  # config.single_label = true
+
+  # Controls what will be passed to the format flag in `git for-each-ref`
+  # Defaults to `tag`.
+  # @return [String]
+  # config.for_each_ref_format = "tag"
+
+  # Determines whether to use the last two tags to
+  # find commits for the output or if this gem should just
+  # find all commits after previous tag
+  # Defaults to `true`.
+  # @return [Boolean]
+  # config.update_release_notes_before_tag = true
 end

data/lib/release/notes.rb

@@ -3,6 +3,10 @@
 require "active_support"
 require "active_support/core_ext/time"
 
+require "thor"
+require "release/notes/cmd"
+
+require "release/notes/errors"
 require "release/notes/configurable"
 require "release/notes/date_formatter"
 require "release/notes/link"
@@ -26,19 +30,9 @@ module Release
     NEWLINE = "\n"
 
     class << self
-      def generate
-        log.perform
-      end
-
       def root
         File.expand_path("..", __dir__)
       end
-
-      private
-
-      def log
-        Log.new
-      end
     end
   end
 end

data/lib/release/notes/cmd.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class Cmd < Thor
+      desc "generate", "Generate release notes"
+      option :tag, type: :string,
+                   aliases: "-t",
+                   desc: "The latest tag to use on the file title if the tag is not yet pushed"
+      option :'force-rewrite', type: :boolean,
+                               default: false,
+                               aliases: "-r",
+                               desc: "Force release-notes to look at all previous "\
+                             "tags and rewrite the output file"
+      option :'ignore-head', type: :boolean,
+                             default: false,
+                             aliases: "-i",
+                             desc: "If updating your changelog and you don't want the latest commits "\
+                                    "from the last tag to HEAD in a single "\
+                                    "instance of running, set to true"
+      def generate
+        warn "=> Generating release notes..."
+        Log.new(options).perform
+        warn "=> Done!"
+      end
+    end
+  end
+end

data/lib/release/notes/configurable.rb

@@ -3,14 +3,35 @@
 module Release
   module Notes
     module Configurable
-      delegate :timezone, :grep_insensitive?, :regex_type,
-               :include_merges?, :link_to_labels, :link_to_sites, :link_to_humanize,
-               :log_all, :header_title, :header_title_type, :features,
-               :bugs, :misc, :feature_title,
-               :bug_title, :misc_title, :log_all_title, :single_label,
-               :output_file, :temp_file, :link_commits?, :all_labels,
-               :prettify_messages?, :release_notes_exist?, :for_each_ref_format,
-               :force_rewrite, prefix: :config, to: :"Release::Notes.configuration"
+      delegate :all_labels,
+               :bug_title,
+               :bugs,
+               :feature_title,
+               :features,
+               :for_each_ref_format,
+               :force_rewrite?,
+               :grep_insensitive_flag,
+               :header_title_type,
+               :ignore_head?,
+               :link_commits?,
+               :link_to_humanize,
+               :link_to_labels,
+               :link_to_sites,
+               :log_all,
+               :log_all_title,
+               :merge_flag,
+               :misc,
+               :misc_title,
+               :newest_tag,
+               :output_file,
+               :prettify_messages?,
+               :regex_type,
+               :release_notes_exist?,
+               :single_label,
+               :temp_file,
+               :timezone,
+               :update_release_notes_before_tag?,
+               prefix: :config, to: :"Release::Notes.configuration"
     end
   end
 end

data/lib/release/notes/configuration.rb

@@ -114,11 +114,6 @@ module Release
       # @return [Boolean]
       attr_accessor :prettify_messages
 
-      # Controls whether to rewrite the output file or append to it.
-      # Defaults to `false`.
-      # @return [Boolean]
-      attr_accessor :force_rewrite
-
       # If a commit message contains words that match more than
       # one group of labels as defined in your configuration, the output
       # will only contain the commit once.
@@ -131,29 +126,45 @@ module Release
       # @return [String]
       attr_accessor :for_each_ref_format
 
+      # Determines whether to use the last two tags to
+      # find commits for the output or if this gem should just
+      # find all commits after previous tag
+      # Defaults to `true`.
+      # @return [Boolean]
+      attr_accessor :update_release_notes_before_tag
+
       def initialize
-        @output_file           = "./RELEASE_NOTES.md"
-        @temp_file             = "./release-notes.tmp.md"
-        @include_merges        = false
-        @ignore_case           = true
-        @extended_regex        = true
-        @header_title          = "tag"
-        @bug_labels            = %w(Fix Update)
-        @feature_labels        = %w(Add Create)
-        @misc_labels           = %w(Refactor)
-        @bug_title             = "**Fixed bugs:**"
-        @feature_title         = "**Implemented enhancements:**"
-        @misc_title            = "**Miscellaneous:**"
-        @log_all_title         = "**Other**"
-        @log_all               = false
-        @link_to_labels        = %w()
-        @link_to_humanize      = %w()
-        @link_to_sites         = %w()
-        @timezone              = "America/New_York"
-        @prettify_messages     = false
-        @force_rewrite         = false
-        @single_label          = true
-        @for_each_ref_format   = "tag"
+        @output_file                      = "./RELEASE_NOTES.md"
+        @temp_file                        = "./release-notes.tmp.md"
+        @include_merges                   = false
+        @ignore_case                      = true
+        @extended_regex                   = true
+        @header_title                     = "tag"
+        @bug_labels                       = %w(Fix Update)
+        @feature_labels                   = %w(Add Create)
+        @misc_labels                      = %w(Refactor)
+        @bug_title                        = "**Fixed bugs:**"
+        @feature_title                    = "**Implemented enhancements:**"
+        @misc_title                       = "**Miscellaneous:**"
+        @log_all_title                    = "**Other**"
+        @log_all                          = false
+        @link_to_labels                   = %w()
+        @link_to_humanize                 = %w()
+        @link_to_sites                    = %w()
+        @timezone                         = "America/New_York"
+        @prettify_messages                = false
+        @single_label                     = true
+        @for_each_ref_format              = "tag"
+        @update_release_notes_before_tag  = true
+      end
+
+      instance_methods.each do |meth|
+        define_method("#{meth}?") do
+          return send(meth) == true if !!send(meth) == send(meth) # rubocop:disable Style/DoubleNegation
+
+          raise NotBoolean, "Configuration##{meth} does not return a Boolean and
+            therefore, has no predicate method."
+        end
       end
 
       # @return [String]
@@ -162,18 +173,18 @@ module Release
       end
 
       # @return [String]
-      def include_merges?
-        @include_merges ? "" : "--no-merges"
+      def merge_flag
+        include_merges? ? "" : "--no-merges"
       end
 
       # @return [String]
       def regex_type
-        @extended_regex ? "-E" : ""
+        extended_regex? ? "-E" : ""
       end
 
       # @return [String]
-      def grep_insensitive?
-        @ignore_case ? "-i" : ""
+      def grep_insensitive_flag
+        ignore_case? ? "-i" : ""
       end
 
       # @return [String]
@@ -207,9 +218,15 @@ module Release
           link_to_sites.present?
       end
 
-      # @return [Boolean]
-      def prettify_messages?
-        @prettify_messages
+      def set_instance_var(var, val)
+        instance_variable_set("@#{var}", val)
+        define_singleton_method(var) do
+          instance_variable_get("@#{var}")
+        end
+
+        define_singleton_method("#{var}?") do
+          return send(var) == true if !!send(var) == send(var) # rubocop:disable Style/DoubleNegation
+        end
       end
 
       private

data/lib/release/notes/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Release
+  module Notes
+    class MissingTag < ArgumentError; end
+    class NotBoolean < TypeError; end
+  end
+end

data/lib/release/notes/git.rb

@@ -20,8 +20,8 @@ module Release
         def log(**opts)
           "git log '#{opts[:tag_from]}'..'#{opts[:tag_to]}'" \
             " --grep='#{opts[:label]}#{opts[:invert_grep]}'" \
-            " #{config_regex_type} #{config_grep_insensitive?}" \
-            " #{config_include_merges?} --format='%h #{log_format}'"
+            " #{config_regex_type} #{config_grep_insensitive_flag}" \
+            " #{config_merge_flag} --format='%h #{log_format}'"
         end
 
         #

data/lib/release/notes/link.rb

@@ -97,7 +97,7 @@ module Release
         def replace(line, issue_number, label, index)
           identifier = "#{label.split(/\s/)[0]} #{issue_number}"
           humanized = "#{config_link_to_humanize[index]} #{issue_number}"
-          linked = "[#{humanized}](#{config_link_to_sites[index]}\/#{issue_number.tr('^0-9', '')})"
+          linked = "[#{humanized}](#{config_link_to_sites[index]}#{issue_number.tr('^0-9', '')})"
 
           line.gsub! identifier, linked
           line

data/lib/release/notes/log.rb

@@ -5,34 +5,40 @@ module Release
     class Log
       include Configurable
 
+      def initialize(opts = {})
+        Release::Notes.configure do |c|
+          c.set_instance_var(:newest_tag, opts["tag"])
+          c.set_instance_var(:force_rewrite, opts["rewrite"])
+          c.set_instance_var(:ignore_head, opts["ignore-head"])
+        end
+      end
+
       #
       # Release::Notes::Log initializer
       #
       # @return none
       #
       def perform
-        if log_from_start?
-          # Find all tags and get the logs between each tag
-          # run this the first time if nothing exists
-          find_all_tags_and_log_all
-        else
-          # Find the last tag and group all commits
-          # under a date header at the time this is run
-          find_last_tag_and_log
-        end
+        log_from_start? ? find_all_tags_and_log_all : find_last_tag_and_log
 
         writer.write_new_file
       end
 
       private
 
+      def commits_since_last_tag
+        tag_logger("HEAD", find_previous_tag(0))
+      end
+
       #
       # Find the most recent git tag
       #
       # @return [Array] most recent git tag
       #
       def find_last_tag_and_log
-        tag_logger(System.last_tag.strip, previous_tag(0))
+        return commits_since_last_tag if read_to_head?
+
+        tag_logger(System.last_tag.strip, find_previous_tag(1))
       end
 
       #
@@ -42,8 +48,10 @@ module Release
       #
       def find_all_tags_and_log_all
         git_all_tags.each_with_index do |ta, i|
-          tag_logger(ta, previous_tag(i))
+          tag_logger(ta, find_previous_tag(i + 1))
         end
+
+        commits_since_last_tag if read_to_head?
       end
 
       #
@@ -52,7 +60,7 @@ module Release
       # @return [Boolean] append to changelog or start from beginning of git log
       #
       def log_from_start?
-        !config_release_notes_exist? || config_force_rewrite
+        !config_release_notes_exist? || config_force_rewrite?
       end
 
       #
@@ -71,8 +79,12 @@ module Release
       #
       # @return [String] second most recent git tag
       #
-      def previous_tag(index)
-        git_all_tags[index + 1].yield_self { |t| tag(t) }.strip
+      def find_previous_tag(idx)
+        git_all_tags[idx].yield_self { |t| tag(t) }.strip
+      end
+
+      def read_to_head?
+        config_update_release_notes_before_tag? && !config_ignore_head?
       end
 
       #
@@ -95,7 +107,11 @@ module Release
       # @return [Object] Release::Notes::Tag object
       #
       def tag_logger(tag, previous_tag)
-        Tag.new(tag: tag, previous_tag: previous_tag, writer: writer).perform
+        Tag.new(
+          tag: tag,
+          previous_tag: previous_tag,
+          writer: writer,
+        ).perform
       end
 
       #

data/lib/release/notes/tag.rb

@@ -33,11 +33,14 @@ module Release
         store_commits # adds to @_commits
 
         if commits_available? # true
-          writer_digest_header(header_title) # <File:./release-notes.tmp.md (closed)>
+          writer_digest_header(header) # <File:./release-notes.tmp.md (closed)>
           log_commits # hash [0,1,2...], messages for sha
         end
 
         self
+      rescue MissingTag => e
+        warn "<#{e.class.name.demodulize}>: #{e}"
+        raise
       end
 
       private
@@ -67,8 +70,8 @@ module Release
       #
       # @return [String] the header to be added to changelog
       #
-      def header_title
-        config_header_title.yield_self { |t| title(t) } # config_header_title = "tag"
+      def header
+        config_header_title_type.yield_self { |t| title(t) } # config_header_title = "tag"
       end
 
       #
@@ -145,6 +148,15 @@ module Release
       # @return [String] tag title or formatted tag date to be added to changelog
       #
       def title(title)
+        return standard_title(title) unless config_update_release_notes_before_tag? && tag == "HEAD"
+
+        formatted_date unless title == "tag"
+        return config_newest_tag if config_newest_tag.present?
+
+        raise MissingTag, "No tag version was passed as an option when generating release notes"
+      end
+
+      def standard_title(title)
         title == "tag" ? tag : formatted_date(tag_date)
       end
     end

data/lib/release/notes/version.rb

@@ -2,6 +2,6 @@
 
 module Release
   module Notes
-    VERSION = "3.1.0"
+    VERSION = "4.0.0.pre"
   end
 end

data/lib/release/notes/write.rb

@@ -56,7 +56,7 @@ module Release
       # @return none
       #
       def write_new_file
-        copy_over_notes if config_release_notes_exist? && !config_force_rewrite
+        copy_over_notes if config_release_notes_exist? && !config_force_rewrite?
 
         FileUtils.cp(config_temp_file, config_output_file)
         FileUtils.rm config_temp_file

data/release-notes.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", "~> 5.0"
+  spec.add_dependency "thor", "~> 0.20"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "pry", "~> 0.12.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0.pre
 platform: ruby
 authors:
 - Drew Monroe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,10 +126,12 @@ files:
 - lib/generators/release/notes/install/templates/README
 - lib/generators/release/notes/install/templates/release_notes.rb
 - lib/release/notes.rb
+- lib/release/notes/cmd.rb
 - lib/release/notes/commits.rb
 - lib/release/notes/configurable.rb
 - lib/release/notes/configuration.rb
 - lib/release/notes/date_formatter.rb
+- lib/release/notes/errors.rb
 - lib/release/notes/git.rb
 - lib/release/notes/install.rb
 - lib/release/notes/link.rb
@@ -127,7 +143,6 @@ files:
 - lib/release/notes/tasks/install.rake
 - lib/release/notes/version.rb
 - lib/release/notes/write.rb
-- lib/tasks/update_release_notes.rake
 - release-notes.gemspec
 homepage: http://github.com/dvmonroe/release-notes
 licenses:
@@ -144,9 +159,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3

data/lib/tasks/update_release_notes.rake

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-namespace :update_release_notes do
-  task :run do
-    puts "=> Generating release notes..."
-    Release::Notes.generate
-    puts "=> Done!"
-  end
-end