structured_changelog 0.8.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 039e8126bbe0d2248dbc9c3b6baeac898c58178e
-  data.tar.gz: f92ca1915c1e0aa2a199d85f83a1be7f4154d0ce
+  metadata.gz: 5cfa0269a454722bb8144fee70626dbd4afddcb5
+  data.tar.gz: cd69bdcbdf0a54b210868bf7476b2fd92b759665
 SHA512:
-  metadata.gz: e06c3e60b2dc080867b919f59de5e74f85d3dd7af1e6696ed3cc1647aa47581ddf011b2b63c12222ad968a64e6a4097924935f44296d87091193b76564f1cfa8
-  data.tar.gz: bc2cc2b4c9b4c187b1fd203f1c1df68efccec9edd23b92d3a6c1b187cd4512167f2e5bc3f758a23bf703947f15d724132b13447cf7809919bc9f20267f63805d
+  metadata.gz: cb59d3cd247e5618d277e173d067b23037935d8c008ec84c7b907ffb39c1cdabf5e473caffb8bd8b23915dd3414503fcd8de3aed2b1972200a9891d2d0e10958
+  data.tar.gz: 43512333d80038357eeba472bfa991e33f3f35181474d13def7a716a526d980fd8c501ed3426cdef47c800cd7b86e7320bef427b2c76adc993385dfe450da470

data/CHANGELOG.md

@@ -1,16 +1,18 @@
-## ROADMAP 1.1.0
+## ROADMAP
 
 * investigate partial parsing of a file if parsing slows down *too much* on large changelogs
-
-## ROADMAP 1.0.0
-
-* consider moving from BREAKING/FEATURE/FIX to MAJOR/MINOR/PATCH
-* validate that each line starts with BREAKING:/FEATURE:/FIX:
-* validate that each release has the appropriate version
-* validate that release numbers increase monotonically
+* 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
 
+## RELEASE 0.10.0
+
+* FEATURE: `changelog:compile` task that pulls all `[CHANGELOG]` commit messages since the last release, determines the minimum necessary release version, and appends a new section to the top of the releases in the changelog. See the README for more information.
+
+## RELEASE 0.9.0
+
+* FEATURE: `changelog:prep` task that performs `changelog:validate`, `changelog:sync`, and `changelog:commit`.
+
 ## RELEASE 0.8.3
 
 * FIX: `Gemfile.lock` now gets updated with the new version before `changelog:commit` runs during `changelog:release`

data/README.md

@@ -8,40 +8,67 @@ Add this to your Rakefile:
 require 'structured_changelog/tasks'
 ```
 
-This will create a `rake changelog:release` task that:
+## With A Single Contributor
 
-1. validates your `CHANGELOG.md`
-2. sets your gem's `VERSION` constant to the latest release version specified by your `CHANGELOG.md`
-3. commits that version bump
-4. runs `rake release`
+If you have a single-contributor project, you can simply add release lines to `CHANGELOG.md`:
 
-Turns out modifying `rake release` was _way_ more trouble than it was worth, so we had to make a separate task. Sorry folks.
+```
+* FEATURE: we added a new thing
+* FIX: we fixed a broken thing
+```
 
-You'll also get these wonderful rake tasks:
+then when you want to cut a release, add a `"## RELEASE X.Y.Z"` section, making the above look like:
 
-## Wonderful Rake Tasks
+```
+## RELEASE X.Y.Z
 
-To validate your changelog:
+* FEATURE: we added a new thing
+* FIX: we fixed a broken thing
+```
 
-    $ rake changelog:validate
-    
-To update your gem's `VERSION` constant to the latest release in your Changelog:
+and run
 
-    $ rake changelog:sync
+    $ rake changelog:release
 
-To commit your version bump--and only your version bump:
+This will:
 
-    $ rake changelog:commit
+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)
 
-To determine the version of the latest release *according to the Changelog*:
+## With Multiple Contributors
 
-    $ rake changelog:version
+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 changelog lines, instead of adding it directly to the changelog, write a git commit:
+
+```
+[CHANGELOG]
+
+* FEATURE: we added a new thing
+* FIX: we fixed a thing that was broken
+```
+
+The commit message needs to start with `[CHANGELOG]\n\n` and each line should start with `* BREAKING: `, `* FEATURE: `, `* FIX: `, `* ENHANCEMENT: `, or `* DEPRECATION: `.
+
+Then, when you're ready to cut a release, run:
+
+    $ rake changelog:compile
+    
+This will pull all the `[CHANGELOG]` commit message bodies you've written 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]
@@ -70,6 +97,28 @@ 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:

data/lib/structured_changelog/core_ext/gem.rb

@@ -0,0 +1,33 @@
+class StructuredChangelog
+  module VersionInstanceMethods
+    def bump_major
+      bump_at_segment_index(0)
+    end
+
+    def bump_minor
+      bump_at_segment_index(1)
+    end
+
+    def bump_patch
+      bump_at_segment_index(2)
+    end
+
+    private
+
+    def bump_at_segment_index(index)
+      unbumped_segments = segments[0...index]
+      bumped_segment    = [segments[index] + 1]
+      # zero out the remaining segments until we hit a non-numeric (rc, say) segment
+      trailing_zeroes   = [0] * segments[(index + 1)..-1].take_while { |x| x.is_a?(Fixnum) }.size
+
+      bumped_segments =
+        unbumped_segments +
+        bumped_segment +
+        trailing_zeroes
+
+      self.class.new(bumped_segments.join('.'))
+    end
+  end
+end
+
+Gem::Version.send(:include, StructuredChangelog::VersionInstanceMethods)

data/lib/structured_changelog/core_ext/string.rb

@@ -0,0 +1,9 @@
+class StructuredChangelog
+  module StringInstanceMethods
+    def match?(*args)
+      !!match(*args)
+    end
+  end
+end
+
+String.send(:include, StructuredChangelog::StringInstanceMethods)

data/lib/structured_changelog/tasks/compile.rb

@@ -0,0 +1,42 @@
+require 'structured_changelog'
+require 'structured_changelog/core_ext/string'
+require 'structured_changelog/core_ext/gem'
+require 'git'
+
+task "changelog:compile", [:repo_path, :changelog_path] do |_task, arguments|
+  repo_path      = arguments.to_h.fetch(:repo_path)      { Pathname.pwd }
+  changelog_path = arguments.to_h.fetch(:changelog_path) { Pathname.pwd/"CHANGELOG.md" }
+
+  current_version = StructuredChangelog.new(changelog_path).version
+
+  repo = Git.open(repo_path)
+
+  commit_messages = repo.log.since("v#{current_version}").map(&:message).select do |message|
+    message.match?(/^\[CHANGELOG\]\n\n\*\ /)
+  end
+
+  abort("No [CHANGELOG] commits since the last release") if commit_messages.empty?
+
+  message = commit_messages.flat_map do |message|
+    message.sub(/^\[CHANGELOG\]\n\n/, "")
+  end.join("\n")
+
+  new_version = if message.match?(/^*\ BREAKING:/)
+                  current_version.bump_major
+                elsif message.match?(/^*\ FEATURE:/)
+                  current_version.bump_minor
+                elsif message.match?(/^*\ FIX:/)
+                  current_version.bump_patch
+                elsif message.match?(/^*\ ENHANCEMENT:/)
+                  current_version.bump_patch
+                elsif message.match?(/^*\ DEPRECATION:/)
+                  current_version.bump_patch
+                end
+
+  changelog_path.write(
+    changelog_path.read.sub(
+      /^##\ RELEASE\ #{current_version}/,
+      "## RELEASE #{new_version}\n\n#{message}\n\n## RELEASE #{current_version}"
+    )
+  )
+end

data/lib/structured_changelog/tasks/prep.rb

@@ -0,0 +1,7 @@
+desc "Validates your Changelog, updates your VERSION constant, then commits that (when you want to PR releases)"
+task "changelog:prep", [:repo_path, :changelog_path, :version_path] do |_task, arguments|
+  Rake::Task['changelog:validate'].execute(arguments)
+  Rake::Task['changelog:sync'].execute(arguments)
+  `bundle`
+  Rake::Task['changelog:commit'].execute(arguments)
+end

data/lib/structured_changelog/tasks/release.rb

@@ -1,9 +1,6 @@
 desc "Validates your Changelog, updates your VERSION constant, commits that, then releases your gem."
 task 'changelog:release', [:repo_path, :changelog_path, :version_path] do |_task, arguments|
-  Rake::Task['changelog:validate'].execute(arguments)
-  Rake::Task['changelog:sync'].execute(arguments)
-  `bundle`
-  Rake::Task['changelog:commit'].execute(arguments)
+  Rake::Task['changelog:prep'].execute(arguments)
 
   # Merely requiring `bundler/gem_tasks` instantiates & caches a gemspec. At this point in this code,
   # it's already set and attached to the `Bundler::GemHelper` module. In fact, it's there before this

data/lib/structured_changelog/tasks/sync.rb

@@ -4,7 +4,7 @@ require 'structured_changelog/version_pattern'
 desc "Set the gem's VERSION constant to be the changelog's version"
 task 'changelog:sync', [:changelog_path, :version_path] do |_task, arguments|
   changelog_path = arguments.to_h.fetch(:changelog_path) { "CHANGELOG.md" }
-  version_path   = arguments.to_h.fetch(:version_path)   { "lib/#{Pathname.pwd.basename}/version.rb"}
+  version_path   = arguments.to_h.fetch(:version_path)   { "lib/#{Pathname.pwd.basename}/version.rb" }
 
   changelog    = StructuredChangelog.new(changelog_path)
   version_file = Pathname.new(version_path)

data/lib/structured_changelog/version.rb

@@ -1,3 +1,3 @@
 class StructuredChangelog
-  VERSION = "0.8.3"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,8 @@ files:
 - bin/console
 - bin/setup
 - lib/structured_changelog.rb
+- lib/structured_changelog/core_ext/gem.rb
+- lib/structured_changelog/core_ext/string.rb
 - lib/structured_changelog/release.rb
 - lib/structured_changelog/release_filters.rb
 - lib/structured_changelog/release_filters/base.rb
@@ -138,7 +140,9 @@ files:
 - lib/structured_changelog/roadmap.rb
 - lib/structured_changelog/tasks.rb
 - lib/structured_changelog/tasks/commit.rb
+- lib/structured_changelog/tasks/compile.rb
 - lib/structured_changelog/tasks/notes.rb
+- lib/structured_changelog/tasks/prep.rb
 - lib/structured_changelog/tasks/recent.rb
 - lib/structured_changelog/tasks/release.rb
 - lib/structured_changelog/tasks/sync.rb
@@ -166,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A useful changelog, for a change.