structured_changelog 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 396406c6fa0d6c318cd8955ce3f57a8cc1445b81
-  data.tar.gz: 769f91111b88740ad53fd16629d289c2b4de0378
+  metadata.gz: b739ec968c42936d856aa3788cf0429a1381f1a4
+  data.tar.gz: 7723700057200b69557b1a8fcfbf6842b3b4d60f
 SHA512:
-  metadata.gz: d9222a344007479162ef5471d07ad53ff8d2d229fc34e878e319c883d6c2e186e3d8ad5953aa17c0e5d164c635e6fdfcf127d86406db5947db0c65473bb90874
-  data.tar.gz: 4c40823c93b709f02e1abc1657e4f59c214ed3fd593389d04cd5e56d6d83e0b574b552afec99c0c9bd0a0b3e62311ff57e34c06f01d798ac30947612e09df296
+  metadata.gz: f21e553a2ef385497c4319ac5e5f640c5cadb3e4287e8e21de82e1f71cea7d770ca9afecfc5ed28da237adb0bf79d612f1ae38e1a69fd5f3b3fe24227c385778
+  data.tar.gz: 9c53f76476323d2f51c6fea3eb2562d9109cdf802ebfdb79536b3006dc36e6f4552f4922ba0dbb4c277742d7b2b7533e1fce0b7a97a2325a467fbbf738c1f6b7

data/CHANGELOG.md

@@ -5,6 +5,10 @@
 * require release block lines to be ordered in descending severity
 * disable strict semver version validation before 1.0.0
 
+## RELEASE 0.10.2
+
+* ENHANCEMENT: release lines can now be embedded in any commit message body
+
 ## RELEASE 0.10.1
 
 * FIX: Fixed an issue that resulted in `changelog:compile` pulling in release lines from previous releases

data/README.md

@@ -41,22 +41,23 @@ This will:
 
 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:
+When you want to add release notes, instead of adding them directly to the changelog, add them to any git commit:
 
 ```
-[CHANGELOG]
+Describe what I did this commit
+
+More description goes here
 
-* 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: `.
+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 `[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
+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
 
@@ -64,7 +65,7 @@ as usual to actually release your gem.
 
 ## Viewing Release Notes
 
-To view the release notes of the current release:
+To view the release notes of the current release:`
 
     $ rake changelog:notes
     $ rake changelog:notes[current]

data/lib/structured_changelog/tasks/compile.rb

@@ -11,32 +11,31 @@ task "changelog:compile", [:repo_path, :changelog_path] do |_task, arguments|
 
   repo = Git.open(repo_path)
 
-  commit_messages = repo.log.between("v#{current_version}").map(&:message).select do |message|
-    message.match?(/^\[CHANGELOG\]\n\n\*\ /)
-  end
+  release_notes = repo.log.between("v#{current_version}").
+    map(&:message).
+    flat_map { |message| message.split("\n") }.
+    grep(/^\*\ (BREAKING|FEATURE|ENHANCEMENT|FIX|DEPRECATION)\:/).
+    map(&:strip).
+    join("\n")
 
-  abort("No [CHANGELOG] commits since the last release") if commit_messages.empty?
+  abort("No release notes since the last release") if release_notes.empty?
 
-  message = commit_messages.flat_map do |message|
-    message.sub(/^\[CHANGELOG\]\n\n/, "")
-  end.join("\n")
-
-  new_version = if message.match?(/^*\ BREAKING:/)
+  new_version = if release_notes.match?(/^*\ BREAKING:/)
                   current_version.bump_major
-                elsif message.match?(/^*\ FEATURE:/)
+                elsif release_notes.match?(/^*\ FEATURE:/)
                   current_version.bump_minor
-                elsif message.match?(/^*\ FIX:/)
+                elsif release_notes.match?(/^*\ FIX:/)
                   current_version.bump_patch
-                elsif message.match?(/^*\ ENHANCEMENT:/)
+                elsif release_notes.match?(/^*\ ENHANCEMENT:/)
                   current_version.bump_patch
-                elsif message.match?(/^*\ DEPRECATION:/)
+                elsif release_notes.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}"
+      "## RELEASE #{new_version}\n\n#{release_notes}\n\n## RELEASE #{current_version}"
     )
   )
 end

data/lib/structured_changelog/version.rb

@@ -1,3 +1,3 @@
 class StructuredChangelog
-  VERSION = "0.10.1"
+  VERSION = "0.10.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured_changelog
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Chris Hoffman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-06 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler