release-notes 1.0.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb0b98d5a15dd9a96c2f431aba996b34aafaeeff0b14c402d742b00eadb97fba
-  data.tar.gz: 261217599cb38ffc79908c7039af54f3c263bfcf8fa11c1523f08e0d0b754ab0
+  metadata.gz: 0bb986c1d6491539b7aae9abb3b1a789c0521aced3843e2bb0c3fcad78edc3b4
+  data.tar.gz: 5ff8bfd9a11045be80e1e90efa107b7ef53a1f4bd0af457d5faff490c5b58cbf
 SHA512:
-  metadata.gz: 780b3d9e8f55ffa5384f2886ccdfba0192e98fef078dd10a82fe5df72b3dea21ec99f24d1dc1ceb483bb1325a7dbc1e108b54381293e6b2f566ac33c40d57d7a
-  data.tar.gz: 65dd44cd18a4b003b2939f97c2e988081083198ae28f2e4e93296d2e3a583f0753239b12e9a85601d8091fa4663736ea11996f2dd4ffc2a546e2baa672a9b4c7
+  metadata.gz: 1c0687d912826f94ce941c65bdb8a6709c796a02a2554312aa2ed109672a663316c06ea403d5fc2a6bcce0d2d8a59c6020935bc7a542c005d48dd8d76f6a70de
+  data.tar.gz: 70e57e14fac4daf6c6520298c93a6c38b502db0b66fd01fd5439addd662f15eb3adc73ccdae4488b71cb7c1b59679991678eb572c63be57f79a15ce69e46f20e

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -6,7 +6,7 @@ Please include a summary of the change and which issue is fixed.
 
 Fixes # (issue)
 
-## Programmer Checklist
+## Checklist
 
 - [ ] My code follows the style guidelines of this project
 - [ ] I have rebased the branch with the latest code from master

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Bugs
+
+Think you’ve discovered a bug?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "release-notes", git: "git@github.com:n2publishing/release-notes.git"
+```
+
+If the above steps don’t help, create an issue.
+
+- For exceptions, include the complete backtrace.
+
+## New Features
+
+If you’d like to discuss a new feature, create an issue and add the `Enhancement` GH label.
+
+## Pull Requests
+
+Create a pull request against master. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+- Add one or more tests if possible. Make sure existing tests pass with:
+
+```sh
+bin/test
+```
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+---

data/README.md

@@ -77,6 +77,7 @@ Release::Notes.configure do |config|
   config.link_to_humanize = %w()
   config.link_to_sites = %w()
   config.timezone = 'America/New_York'
+  config.prettify_messages = true
   config.force_rewrite = false
 end
 ```
@@ -176,13 +177,11 @@ includes this last commit.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/release-notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/release-notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributing Guide](https://github.com/dvmonroe/release-notes/CONTRIBUTING.md).
 
 ## License
 

data/bin/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+bundle exec rake spec

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

@@ -1,22 +1,120 @@
 # frozen_string_literal: true
 
 Release::Notes.configure do |config|
+  # 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
+
+  # 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.log_format = '- %s'
+
+  # 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
+
+  # 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)
+
+  # 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()
+
+  # 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 `true`.
+  # @return [Boolean]
+  # config.prettify_messages = true
+
+  # Controls whether to rewrite the output file or append to it.
+  # Defaults to `false`.
+  # @return [Boolean]
+  # config.force_rewrite = false
 end

data/lib/release/notes/link.rb

@@ -20,7 +20,7 @@ module Release
         # @api private
         def split_lines(lines)
           lines.split("\n").each do |line|
-            unless link_to_labels { |la| line.include? la }
+            unless link_to_labels&.any? { |la| line.include? la }
               @new_lines += "#{line}\n"
               next
             end

data/lib/release/notes/log.rb

@@ -43,8 +43,7 @@ module Release
       end
 
       # @api private
-      def copy_single_tag_of_activity(tag_from:, tag_to: nil)
-        tag_to ||= "HEAD"
+      def copy_single_tag_of_activity(tag_from:, tag_to: "HEAD")
         [features, bugs, misc].each_with_index do |regex, i|
           log = system_call(tag_from: tag_from, tag_to: tag_to, label: regex, log_all: false)
           digest_title(title: titles[i], log_message: log) if log.present?

data/lib/release/notes/version.rb

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

data/lib/release/notes/write.rb

@@ -29,9 +29,7 @@ module Release
         @title = title
         @log_message = log_message
 
-        titles = ""
-        titles << title_present
-        titles << "#{remove_tags}\n"
+        titles = title_present + "#{remove_tags}\n"
         digest(titles)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: release-notes
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Drew Monroe
@@ -95,12 +95,14 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- bin/test
 - lib/generators/release/notes/install/install_generator.rb
 - lib/generators/release/notes/install/templates/README
 - lib/generators/release/notes/install/templates/release_notes.rb
@@ -133,9 +135,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6