structured_changelog 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cac491ab13fd370431dc683aea84b1ce386d3331
-  data.tar.gz: 3d07c2896c7888ba2878ebb58777dad97b1ef961
+SHA256:
+  metadata.gz: 2d8ad3a77ee54fd040cb4b7af19e9c1090132520867d576c9e103d7cf8fb1894
+  data.tar.gz: e127913aee34cf8b9b7e20cae6df2c6407b765fd0efc02830ae05ae92ed1aed2
 SHA512:
-  metadata.gz: 702bf465bfe2a3e7f138f8fb9bdd65aec91aa2f2edc432db5c1b10feb5b12ed1d9fd05459c7f3008abe8faec7c4cf775076c2a4e78bc59995094c51674895d57
-  data.tar.gz: 8fd1ed2a0d6d0be5b358fc3354e4e24333c5cce67c91b0cb608b0760a04682496218bc60f03de829956078806592a3191e58fb0181feef4726de6394e3fe82c7
+  metadata.gz: 3259db0a48e95f16e4392769f629124f8b657b7e2a132b037195e08cb506d9000b573905edc1c738fb1bba4ae844669776a98c65db5f3362b15532113732fb38
+  data.tar.gz: e56b43145532327ae302dea051d02c4b35e5be4c5cbb4521451eb82ff14e18271327f0f16c9e4fb64bb9500bfed2bfe1e4614613144fb149075102bf3fe0502d

data/CHANGELOG.md

@@ -2,8 +2,12 @@
 
 * investigate partial parsing of a file if parsing slows down *too much* on large changelogs
 * validate that each line starts with BREAKING/FEATURE/FIX/ENHANCEMENT/DEPRECATION
-* require release block lines to be ordered in descending severity
 * disable strict semver version validation before 1.0.0
+* `rake changelog:todos` to show todos that, based on the current commit history release lines, need to be fixed before the next release.
+
+## RELEASE 0.11.2
+
+* ENHANCEMENT: Now if you use `BREAKING: we broke a thing` instead of `* BREAKING: we broke a thing` in a git commit message release line, the `rake changelog:preview` and `rake changelog:compile` tasks will still retrieve those commit lines
 
 ## RELEASE 0.11.1
 

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in structured_changelog.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/README.adoc

@@ -0,0 +1,291 @@
+= StructuredChangelog
+:ext-relative: .adoc
+:source-highlighter: coderay
+:sectanchors:
+:linkattrs:
+:icons: font
+:toc: macro
+:toc-title:
+:toclevels: 3
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+image:https://badge.fury.io/rb/structured_changelog.svg["Gem Version", link="https://badge.fury.io/rb/structured_changelog"]
+image:https://travis-ci.org/yarmiganosca/structured_changelog.svg?branch=master["Build Status", link="https://travis-ci.org/yarmiganosca/structured_changelog"]
+image:https://coveralls.io/repos/github/yarmiganosca/structured_changelog/badge.svg?branch=master["Test Coverage", link="https://coveralls.io/github/yarmiganosca/structured_changelog?branch=master"]
+
+toc::[]
+
+You have a changelog in your gem's repo, right? Great! Then you'll never need to manually update your `VERSION` constant again!
+
+<<Installation,Install the gem>> and add this line to your Rakefile:
+
+[source,ruby]
+----
+require 'structured_changelog/tasks'
+----
+
+== With A Single Contributor
+
+If you have a single-contributor project, you can simply add release lines to `CHANGELOG.md`:
+
+----
+* FEATURE: we added a new thing
+* FIX: we fixed a broken thing
+----
+
+then when you want to cut a release, add a `"## RELEASE X.Y.Z"` section, making the above look like:
+
+----
+## RELEASE X.Y.Z
+
+* FEATURE: we added a new thing
+* FIX: we fixed a broken thing
+----
+
+and run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:release
+----
+
+This will:
+
+1. validate your `CHANGELOG.md`
+2. set your gem's `VERSION` constant to the latest release version specified by your `CHANGELOG.md`
+3. commit that version bump
+4. package your gem and push it to the specified gem server (rubygems.org by default)
+
+== With Multiple Contributors
+
+If you have multiple contributors, and you follow the single-contributor workflow, you'll end up with git merge conflicts every time different contributes add lines to the changelog in different Pull Requests. Fortunately, there's a separate workflow for projects with multiple contributors.
+
+NOTE: Even though it was expliticitly designed for projects with multiple contributors, this workflow works just as well for projects with a single author--in fact I use it for structured_changelog.
+
+When you want to add release notes, instead of adding them directly to the changelog, add them to any git commit:
+
+----
+Describe what I did this commit
+
+More description goes here
+
+* FIX: we fixed a thing that was broken
+----
+
+Any line in a commit message that starts with any of the following will be included in the release notes for the next version:
+
+* ``* BREAKING: `` or ```BREAKING: ```
+* ```* FEATURE: ``` or ```FEATURE: ```
+* ```* ENHANCEMENT: ``` or ```ENHANCEMENT: ```
+* ```* FIX: ``` or ```FIX: ```
+* ```* DEPRECATION: ``` or ```DEPRECATION: ```
+
+(We accept either with or without the asterisks so that forgetting one isn't actually a problem).
+
+Then, when you're ready to cut a release, run:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:compile
+----
+
+This will pull all the release lines you've written in git commit messages since the last release from the commit log, and create a new release section in your changelog. It will have the minimum version possible given the change types (BREAKING is a major bump, FEATURE is a minor bump, and FIX, ENHANCEMENT, and DEPRECATION are all patch bumps).
+
+Once the rake task has written the new section to the changelog, it's often beneficial to give it a look and make sure it's free of typos and any other mistakes. Then, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:release
+----
+
+as usual to actually release your gem.
+
+== Viewing Release Notes
+
+To view the release notes of the current release:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes
+----
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes[current]
+----
+
+To view the release notes of every release:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes[all]
+----
+
+for a specific release:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes[1.0.4]
+----
+
+for all releases inclusively after a given release:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes[1.0.4 <]
+----
+
+for all releases inclusively before a given release:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes[< 2.0.4]
+----
+
+for all releases inclusively between two releases:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:notes[1.0.4 < 2.0.4]
+----
+
+To view the last 3 releases:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:recent
+----
+
+To view the last N releases:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:recent[N]
+----
+
+== Other Rake Tasks
+
+To determine the version of the latest release *according to the Changelog*:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:version
+----
+
+To validate your changelog:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:validate
+----
+    
+To update your gem's `VERSION` constant to the latest release in your Changelog:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:sync
+----
+
+To commit your version bump--and only your version bump:
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:commit
+----
+
+To do everything but release your code (so that it can go through a PR for CI, for instance):
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++rake changelog:prep
+----
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'structured_changelog'
+----
+
+And then execute
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle install
+----
+
+Or, install it yourself with
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++gem install structured_changelog
+----
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yarmiganosca/structured_changelog.
+
+[IMPORTANT]
+.Code of Conduct
+====
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the http://contributor-covenant.org[Contributor Covenant] code of conduct.
+====
+
+=== 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`.
+
+=== Testing
+
+To run all the tests, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rspec
+----
+
+=== Pull Requests
+
+Pull requests should be well-scoped and include tests appropriate to the changes.
+
+When submitting a pull request that changes user-facing behavior, add release note lines to the commit message body http://github.com/yarmiganosca/structured_changelog#with-multiple-contributors[like this]. You can preview your release lines by running
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rake changelog:preview
+----
+
+=== Releases
+
+Releasing a new version is a 2-step process.
+
+First, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rake changelog:compile
+----
+
+This will add a new release section before the other release sections. It will contain all the release notes in the commit messages since the last release, and will be prepopulated with the minimum possible version given those changes. Proof-read it and reorder the notes if you think doing so would be necessary or clearer. Feel free to increase the version if necessary (to force a major release, for example).
+
+Once you're satisfied, run
+
+[subs=+macros]
+----
++++<span style="pointer-events:none;user-select:none;">$ </span>+++bundle exec rake changelog:release
+----
+
+This will create a git tag for the version, push git commits and tags, and push the `.gem` file to https://rubygems.org[rubygems.org].
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].

data/lib/structured_changelog/release_preview.rb

@@ -21,11 +21,16 @@ class StructuredChangelog
     attr_reader :changelog, :repo
 
     def release_notes
-      @release_notes ||= git_log_since_last_release.
-        split("\n").
-        map(&:strip).
-        grep(/^\*\ (BREAKING|FEATURE|ENHANCEMENT|FIX|DEPRECATION)\:/).
-        join("\n")
+      @release_notes ||= git_log_since_last_release
+        .split("\n")
+        .map(&:strip)
+        .grep(/#{optional_prefix_pattern}(BREAKING|FEATURE|FIX|ENHANCEMENT|DEPRECATION):\ /)
+        .map { |release_line| release_line.sub(optional_prefix_pattern, "* ") }
+        .join("\n")
+    end
+
+    def optional_prefix_pattern
+      /^(\*\ )?/
     end
 
     def git_log_since_last_release
@@ -39,15 +44,15 @@ class StructuredChangelog
     end
 
     def new_version
-      @new_version ||= if release_notes.match?(/^*\ BREAKING:/)
+      @new_version ||= if release_notes.match?(/#{optional_prefix_pattern}BREAKING:\ /)
                          current_version.bump_major
-                       elsif release_notes.match?(/^*\ FEATURE:/)
+                       elsif release_notes.match?(/#{optional_prefix_pattern}FEATURE:\ /)
                          current_version.bump_minor
-                       elsif release_notes.match?(/^*\ FIX:/)
+                       elsif release_notes.match?(/#{optional_prefix_pattern}FIX:\ /)
                          current_version.bump_patch
-                       elsif release_notes.match?(/^*\ ENHANCEMENT:/)
+                       elsif release_notes.match?(/#{optional_prefix_pattern}ENHANCEMENT:\ /)
                          current_version.bump_patch
-                       elsif release_notes.match?(/^*\ DEPRECATION:/)
+                       elsif release_notes.match?(/#{optional_prefix_pattern}DEPRECATION:\ /)
                          current_version.bump_patch
                        end
     end

data/lib/structured_changelog/version.rb

@@ -1,3 +1,3 @@
 class StructuredChangelog
-  VERSION = "0.11.1"
+  VERSION = "0.11.2"
 end

data/structured_changelog.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "simplecov"

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-12 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- README.md
+- README.adoc
 - Rakefile
 - bin/console
 - bin/setup
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A useful changelog, for a change.

data/README.md

@@ -1,148 +0,0 @@
-# StructuredChangelog
-
-You have a changelog in your repo, right? Great! Then you'll never need to manually update your `VERSION` constant again!
-
-Add this to your Rakefile:
-
-```ruby
-require 'structured_changelog/tasks'
-```
-
-## With A Single Contributor
-
-If you have a single-contributor project, you can simply add release lines to `CHANGELOG.md`:
-
-```
-* FEATURE: we added a new thing
-* FIX: we fixed a broken thing
-```
-
-then when you want to cut a release, add a `"## RELEASE X.Y.Z"` section, making the above look like:
-
-```
-## RELEASE X.Y.Z
-
-* FEATURE: we added a new thing
-* FIX: we fixed a broken thing
-```
-
-and run
-
-    $ rake changelog:release
-
-This will:
-
-1. validate your `CHANGELOG.md`
-2. set your gem's `VERSION` constant to the latest release version specified by your `CHANGELOG.md`
-3. commit that version bump
-4. package your gem and push it to the specified gem server (rubygems.org by default)
-
-## With Multiple Contributors
-
-If you have multiple contributors, and you follow the single-contributor workflow, you'll end up with conflicts every time multiple people go to add a line to the changelog. We have a separate workflow for you.
-
-When you want to add release notes, instead of adding them directly to the changelog, add them to any git commit:
-
-```
-Describe what I did this commit
-
-More description goes here
-
-* FIX: we fixed a thing that was broken
-```
-
-Any line in a commit message that starts with `* BREAKING: `, `* FEATURE: `, `* FIX: `, `* ENHANCEMENT: `, or `* DEPRECATION: ` will be included in the release notes for the next version.
-
-Then, when you're ready to cut a release, run:
-
-    $ rake changelog:compile
-    
-This will pull all the release lines you've written in git commit messages since the last release from the commit log, and create a new release section in your changelog. It will have the minimum version possible given the change types (BREAKING is a major bump, FEATURE is a minor bump, and FIX, ENHANCEMENT, and DEPRECATION are all patch bumps). Once the rake task has written the new section to the changelog, it's often beneficial to give it a look and make sure it's free of typos and any other mistakes. Then, run
-
-    $ rake changelog:release
-
-as usual to actually release your gem.
-
-## Viewing Release Notes
-
-To view the release notes of the current release:
-
-    $ rake changelog:notes
-    $ rake changelog:notes[current]
-
-To view the release notes of every release:
-
-    $ rake changelog:notes[all]
-
-for a specific release:
-
-    $ rake changelog:notes[1.0.4]
-
-for all releases inclusively after a given release:
-
-    $ rake changelog:notes[1.0.4 <]
-
-for all releases inclusively before a given release:
-
-    $ rake changelog:notes[< 2.0.4]
-
-for all releases inclusively between two releases:
-
-    $ rake changelog:notes[1.0.4 < 2.0.4]
-
-To view the last 3 releases:
-
-    $ rake changelog:recent
-
-To view the last N releases:
-
-    $ rake changelog:recent[N]
-
-## Other Rake Tasks
-
-To determine the version of the latest release *according to the Changelog*:
-
-    $ rake changelog:version
-
-To validate your changelog:
-
-    $ rake changelog:validate
-    
-To update your gem's `VERSION` constant to the latest release in your Changelog:
-
-    $ rake changelog:sync
-
-To commit your version bump--and only your version bump:
-
-    $ rake changelog:commit
-
-To do everything but release your code (so that it can go through a PR for CI, for instance):
-
-    $ rake changelog:prep
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'structured_changelog'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install structured_changelog
-
-## 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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/yarmiganosca/structured_changelog. 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.
-