release-notes 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 927c3987045d64e0a0bd179376ed415844bdc1b3d1ab6947a962b5cb2e5acc1f
-  data.tar.gz: db8477ceb4025f41d6bb75419ecedc7fe895fc81e0b358698d324c0ecd2c97e4
+  metadata.gz: 11a25ad25c53aea05501c671b7d7e6b56be58408733ffda7537f727682bc4997
+  data.tar.gz: 64cf10fe71b5486a1f8084c1b735cfa539cf709d1f75c98d6dca55bf88181f05
 SHA512:
-  metadata.gz: a39fdcd2f66ed6adbc6cd70b9ad40c3d06eef3a7599ad17f70e8e12a75258d015e52023a2c74eef26e65eb906b7f9d11f9c0f922367e85de4cc35a334638978a
-  data.tar.gz: e85e34eacab4a9ef925080a1d78e69cb37f393e522af2b58a22362d4400d46f537a1de68f5d6014eb53c56edb4377cebc6d88a5fe2d81ef2d4e088fe5e0ec672
+  metadata.gz: 07046b845aad862743042afda74fc749a22e97904f86c87ca9717b471e6ef2402e5e4145ad5a469405957fabf6cfda7da3362be22ca647be51ce7de7dafcb0cb
+  data.tar.gz: 56dd24a83704f5a108f2b0730fdf8e7a8155aa57ee0ad1dd20f677571fe3273a15a2b6ca07e57ec06ec9473478a98bd3a96ef3a3a7f97a96c03e3f6ab7deb28b

data/.rubocop.yml

@@ -11,11 +11,18 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 
+Metrics/MethodLength:
+  Max: 21
+
 Metrics/BlockLength:
-  Max: 35
+  Max: 40
   Exclude:
     - "./**/spec/**/*"
 
+Metrics/AbcSize:
+  Exclude:
+    - "lib/release/notes/configuration.rb"
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
   Exclude:

data/.travis.yml

@@ -5,13 +5,13 @@ rvm:
   - 2.4.5
   - 2.5.3
 cache: bundler
-before_install: gem install bundler -v 1.12.5
+before_install: gem install bundler -v 1.17.1
 env:
   global:
     secure: ovawk+NnGZGW+hOeC3iPMZ9jKY5FvaxfHLj6XX4Vfe12cq0cdGYirW6pk2uKdJZdE0pC5q4sFv1ZTgcNSTySuNpQ9Gkp4xjcGEVr5JSdmVse8DuxttwkeSPt94DemyMK3f0A3dWN8OJF7/NQbacPeUuXryxmusCqJMlWccVYGeSQQNJ21mFfl2pCf6Z9qls4Q3rzXc4hsVQ5G1B/j9YcMjax0EwXI4cEq/6JadK4OmXrGkCw6M/wvBEqNyhLz+R/gcYiJZqYUETdncRuNiH8N6JKiaCnZUFkGY4bggpOvz29lj3JEQV9jY+3UBeqxuYj3glT7buEuf6//ARedY7IDlupkiDNuSpIKJhzIKAgitc/g+cnUflQV8PiImAEseO0OpoAJ7Bsa688EgyvMgo/kYwjHqZetvlUksQI+XyZ+o7/88LF2Qz4pbuBtdFC4DaKaeqQN5afIHSPtxhYwFA/n+GmY4jymj5ZWod9zZasVdlDgCQzgH5M1W7nEGun8mRW93wf8+3wAx+fXVbB67aDbqJFBJfH6zm/aBCN16kGkHUibRxUyb0F52woBQLUcOIr9Kbujp02D7IK3Z7PFz+DtHfA8aYRXxRDIHxx0tw91UxQzBinsq27kH8EWDmEKMHJeZlMRR4X4ijd6+KFoKUobXFblCeVeO0HCIBxpfTc39w=
 script:
-  - bundle exec rubocop
   - bundle exec rspec
+  - bundle exec rubocop
 
 after_success:
   - bundle exec codeclimate-test-reporter

data/README.md

@@ -1,3 +1,5 @@
+![Imgur](https://i.imgur.com/vTgHEyJ.png)
+
 # Release::Notes
 
 [![Build Status](https://travis-ci.org/dvmonroe/release-notes.svg?branch=master)](https://travis-ci.org/dvmonroe/release-notes)
@@ -5,7 +7,7 @@
 [![Test Coverage](https://codeclimate.com/github/dvmonroe/release-notes/badges/coverage.svg)](https://codeclimate.com/github/dvmonroe/release-notes/coverage)
 [![Inline docs](http://inch-ci.org/github/dvmonroe/release-notes.svg?branch=master)](http://inch-ci.org/github/dvmonroe/release-notes)
 
-Release notes for the stakeholders.
+## Automated release notes based on your project's git log.
 
 Release::Notes is a small wrapper around your project's git log. The gem is
 intended to help increase visability to all team members and/or stakeholders with
@@ -17,7 +19,7 @@ meant for situations where other team members in your organization need to know
 to the production software. These key changes are determined by the labeling you set forth
 in the configuration for features, bugs and misc commits.
 If you're looking for a comprehnsive changelog that reflects resolved github issues and uses the
-github api, I'd  suggest you look at something else like
+github api, I'd suggest you look at something else like
 [github-changelog-generator](https://github.com/skywinder/github-changelog-generator).
 
 Not looking for a tested gem or prefer the rawness of a bash script? Checkout the similar
@@ -65,6 +67,7 @@ Release::Notes.configure do |config|
   config.ignore_case = true
   config.log_format = '- %s'
   config.extended_regex = true
+  config.header_title = "tag"
   config.bug_labels = %w(Fix Update)
   config.feature_labels = %w(Add Create)
   config.misc_labels = %w(Refactor)
@@ -136,7 +139,7 @@ namespace :deploy do
   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"
@@ -156,6 +159,7 @@ Useful information can be found here regarding the
 - 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)
+- We grep the entire commit message when generating the release notes file. If you include keywords in your commit subject and message that match multiple configured labels, that commit will be listed under all relevant label headers, which could lead to commits being listed under more than one label.
 
 ## Development
 

data/lib/generators/release/notes/install/templates/README

@@ -5,7 +5,7 @@ Next step:
 1. Configure release and tag options :
 
     # config/initializers/release_notes.rb
-    config.by_tag_date = false
+    config.header_title = "tag"
 
 
-*******************************************************************************
+*******************************************************************************

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

@@ -37,6 +37,12 @@ Release::Notes.configure do |config|
   # @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)

data/lib/release/notes/configuration.rb

@@ -39,6 +39,11 @@ module Release
       # @return [String]
       attr_accessor :log_format
 
+      # Controls the headers that will be used for your tags
+      # Defaults to `tag`.
+      # @return [String]
+      attr_accessor :header_title
+
       # Controls the labels grepped for in your commit subjects that will
       # be add under you bug title
       # Defaults to `%w(Fix Update)`.
@@ -120,13 +125,14 @@ module Release
       # @return [Boolean]
       attr_accessor :force_rewrite
 
-      def initialize # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def initialize
         @output_file           = "./RELEASE_NOTES.md"
         @temp_file             = "./release-notes.tmp.md"
         @include_merges        = false
         @ignore_case           = true
         @extended_regex        = true
         @log_format            = "- %s"
+        @header_title          = "tag"
         @bug_labels            = %w(Fix Update)
         @feature_labels        = %w(Add Create)
         @misc_labels           = %w(Refactor)
@@ -143,6 +149,11 @@ module Release
         @force_rewrite         = false
       end
 
+      # @return [String]
+      def header_title_type
+        @header_title.match?(/^[tag|date]+$/) ? @header_title : "tag"
+      end
+
       # @return [String]
       def include_merges?
         @include_merges ? "" : "--no-merges"

data/lib/release/notes/git.rb

@@ -17,10 +17,6 @@ module Release
             " #{regex_type} #{grep_insensitive?}" \
             " #{include_merges?} --format='#{log_format}'"
         end
-
-        def invert_log(**opts)
-          log(opts) + " --invert-grep"
-        end
       end
 
       def last_tag

data/lib/release/notes/link.rb

@@ -5,7 +5,7 @@ module Release
     module Link
       extend ActiveSupport::Concern
 
-      included do # rubocop:disable Metrics/BlockLength
+      included do
         delegate :link_to_labels, :link_to_sites, :link_to_humanize, to: :"Release::Notes.configuration"
 
         def link_lines(lines:)

data/lib/release/notes/log.rb

@@ -8,13 +8,13 @@ module Release
       attr_reader :writer, :date_formatter
       attr_reader :all_tags
 
-      delegate :force_rewrite, :all_labels, :log_all, :features,
-               :bugs, :misc, :feature_title,
+      delegate :force_rewrite, :all_labels, :log_all, :header_title,
+               :header_title_type, :features, :bugs, :misc, :feature_title,
                :bug_title, :misc_title, :log_all_title,
                :release_notes_exist?, to: :"Release::Notes.configuration"
 
       delegate :date_humanized, :format_tag_date, to: :date_formatter
-      delegate :digest_date, :digest_title, to: :writer
+      delegate :digest_header, :digest_title, to: :writer
 
       def initialize
         @writer = Release::Notes::Write.new
@@ -37,13 +37,13 @@ module Release
       # :nocov:
       private
 
-      def all_tags # rubocop:disable Lint/DuplicateMethods
-        @all_tags ||= System.all_tags.split("\n")
+      def git_all_tags
+        @git_all_tags ||= System.all_tags.split("\n")
         # return Error.new(msg: :missing_tags) unless all_tags.present?
       end
 
       # @api private
-      def copy_single_tag_of_activity(tag_from:, tag_to: "HEAD") # rubocop:disable Metrics/MethodLength
+      def copy_single_tag_of_activity(tag_from:, tag_to: "HEAD")
         [features, bugs, misc].each_with_index do |regex, i|
           log = system_log(
             tag_from: tag_from,
@@ -70,22 +70,28 @@ module Release
         return false unless system_log(tag_from: last_tag, label: all_labels).present?
 
         # output the date right now
-        digest_date date: date_humanized
+        header_content date: date_humanized, tag: tag_to
         copy_single_tag_of_activity(tag_from: last_tag)
       end
 
       # @api private
       def find_all_tags_and_log_all
-        all_tags.each_with_index do |ta, i|
-          previous_tag = all_tags[i + 1]
+        git_all_tags.each_with_index do |ta, i|
+          previous_tag = git_all_tags[i + 1]
           next unless previous_tag.present? &&
                       system_log(tag_from: previous_tag, tag_to: ta, label: all_labels).present?
 
-          digest_date date: date_humanized(date: System.tag_date(tag: ta))
+          header_content date: date_humanized(date: System.tag_date(tag: ta)), tag: ta
           copy_single_tag_of_activity(tag_from: previous_tag, tag_to: ta)
         end
       end
 
+      # @api private
+      def header_content(**date_and_tag)
+        digest_header(date_and_tag[header_title_type.to_sym])
+      end
+
+      # @api private
       def titles
         [feature_title, bug_title, misc_title]
       end

data/lib/release/notes/system.rb

@@ -8,9 +8,14 @@ module Release
       extend ActiveSupport::Concern
       include Git
 
+      delegate :all_labels, to: :"Release::Notes.configuration"
+
       included do
         def system_log(**opts)
-          return `#{invert_log(opts.merge(label: all_labels, invert_grep: "--invert-grep"))}` if opts[:log_all] == true
+          if opts.delete(:log_all) == true
+            opts[:label] = all_labels
+            opts[:invert_grep] = " --invert-grep"
+          end
 
           `#{log(opts)}`
         end

data/lib/release/notes/version.rb

@@ -2,6 +2,6 @@
 
 module Release
   module Notes
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

data/lib/release/notes/write.rb

@@ -30,10 +30,10 @@ module Release
         digest(titles)
       end
 
-      # formats dates to be added to the new file
-      def digest_date(date: nil)
-        @date = date
-        digest(date_present)
+      # formats the headers to be added to the new file
+      def digest_header(header)
+        @header = header
+        digest(header_present)
       end
 
       # append old file to new temp file
@@ -49,8 +49,8 @@ module Release
       private
 
       # @api private
-      def date_present
-        "\n## #{@date}\n"
+      def header_present
+        "\n## #{@header}\n"
       end
 
       # @api private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Drew Monroe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-30 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport