git-releaselog 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56cebe4847171a0bb6abab7e5cb47adb936f5a5b
-  data.tar.gz: dfbaf79e1bd1ccecdc6b3925a1cd213fb9d259ec
+  metadata.gz: f9a861d8b2cb5f278d565f6c59660a0e39ebe315
+  data.tar.gz: 8ab4bbf3360885dd2fdf8b3f3f0306745ab3eedf
 SHA512:
-  metadata.gz: 2b5ac5be3bc031e8c6bee5b9bd0b720f53cf77addb8b4c0a00ca8e06c73269d1ee792398bb921c5729a14625776af4619abc403d04199cdab40d19a5d7459eb5
-  data.tar.gz: a24b234e7cfea87d14a9995f1906e17387075aa4e1c386eab032ff23302daa9ae9847a5c6c3290150441ec2f802ec956bd8166a60f8f729721ac44a253ce8cd3
+  metadata.gz: a871d0473ccb40284d36a40615cc7d8f5afd70661cea4e175e92cdcfc67d0b9b67e6d29f7cba71f3a2923941b752d9fec0a9ffe68f753744c0fcfe317bf2777e
+  data.tar.gz: bf070da9fd4560327f4fefea9c75c08a641d78f2954802ac32b95089703acc3aecfacec76d00a1d90707a426b4aded82d61c1858654ecbb8b042ddf10940ed59

data/README.md

@@ -1,21 +1,36 @@
+[![Gem Version](https://badge.fury.io/rb/git-releaselog.svg)](http://badge.fury.io/rb/git-releaselog)
+[![Build Status](https://travis-ci.org/iv-mexx/git-releaselog.svg?branch=master)](https://travis-ci.org/iv-mexx/git-releaselog)
+
 # git-releaselog
 
-This tool generates release log from a git repository.
+This tool generates a release log from a git repository.
+
+Its hard or even impossible to generate good releaselog from an ordinary git log. 
+The git log usually contains very detailed, technical information, targeted at the maintainers of a project. 
+
+In contrast, the releaselog should be targetet at the users of a project and should describe changes relevant to those users at a higher abstraction.
+
+Thats why this tool does not attempt to build a releaselog from normal commit messages but instead requires special keywords to mark notes that should show up in the releaselog.
 
-Generally, I don't beliefe that its possible to generate good releaselog
-from an ordinary git log. 
-The git log usually contains very detailed, technical information, targeted
-at the maintainers of a project. 
+These [keywords](#markup) can be used in commit messages. 
 
-In contrast, the releaselog should be targetet at the users of a project and 
-should describe changes relevant to those users at a higher abstraction.
+As an example, check out [the changelog for this repo][releaselog] which is automatically generated using this tool. Furthermore, the git release messages are also generated with this tool, see [this release](https://github.com/iv-mexx/git-releaselog/releases/tag/0.7.0) for example.
+
+## Installation
+
+```
+gem install git-releaselog
+```
 
-Thats why this tool does not attempt to build a releaselog from normal commit
-messages but instead requires special keywords to mark notes that should 
-show up in the releaselog.
+#### Troubleshooting
 
-These [keywords](#markup) can be used in commit messages. See the [Example](#example)
-section.
+If you are having problems with installing the [`rugged`](https://github.com/libgit2/rugged) dependency, maybe you need to install `cmake`:
+
+```
+brew install cmake
+```
+
+Check out the [Install Instructions](https://github.com/libgit2/rugged#install) of the `rugged` gem.
 
 ## Usage
 
@@ -34,10 +49,10 @@ Alternatively, you can choose the generate the whole releaselog for the whole re
 
 * `git-releaselog --complete` will search the whole git log and group the changes nicely in sections by existing tags.
 
-To control the markup of the output, you can use these options (the default is slack):
+To control the markup of the output, you can use the `--format` option (the default is slack):
 
-* `--slack` produces output that looks nice when copy/pasted into slack
-* `--md` produces markdown output in reverse order, e.g this repo's [releaselog]
+* `--format slack` produces output that looks nice when copy/pasted into slack
+* `--format md` produces markdown output in reverse order, e.g this repo's [releaselog]
 
 ## Markup
 
@@ -91,7 +106,7 @@ This is just what works best for us:
 * Create Merge Requests for merging feature branches back to develop
   * Feature branch / merge request should address specific features / fixes / ...
   * The description of the merge request should contain markup for the releaselog
-  * The description of the merge request should be the commit message of the merge commit (done automatically e.g. by gitlab)
+  * The description of the merge request should be the commit message of the merge commit (done automatically e.g. by gitlab, manually for github!)
 
 The only additional step from our normal workflow is to use special markup for the change log in the description of a merge request. 
 Doing so enables the generation of change logs between arbitrary commits / releases
@@ -130,15 +145,17 @@ Date:   Tue May 26 12:49:00 2015 +0200
 
 Notice, that commit `1f4abe3399891cfd429e5aa474e6c414f7e2b3b2` has an extra line with a `feat` keyword.
 The releaselog for these commits looks like this:
-`git-releaselog fa40cdb d41dac9 --md`
 
 ```
-## Unreleased (_26.05.2015_)
-#### Fixes
-_No new Fixes_
+git-releaselog d41dac9 fa40cdb --format md
+```
+
+```
+## Unreleased
+(_26.05.2015_)
 
-#### Features
-* use the `--complete` parameter to generate a complete releaselog over all tags
+#### Feature
+* use the `--complete` parameter to generate a complete changelog over all tags
 ```
 
 [releaselog]: CHANGELOG.md

data/lib/git-releaselog/changelog.rb

@@ -108,7 +108,7 @@ module Releaselog
       str << commit_info { |ci| ci.empty? ? "" : "(_#{ci}_)\n" }
       str << sections(
         changes,
-        -> (header) { "\n*#{header.capitalize}*\n" },
+        -> (header) { "\n#### #{header.capitalize}\n" },
         -> (field, _index) { "* #{field}\n" }
       )
 

data/lib/git-releaselog/changelog_helpers.rb

@@ -6,17 +6,17 @@ include Releaselog
 
 # check if the given refString (tag name or commit-hash) exists in the repo
 def commit(repo, refString, logger)
+  logger.info("Searching for ref #{refString} in repo")
+
   return unless refString != nil
   begin
     repo.lookup(refString)
   rescue Rugged::OdbError => e
-    puts ("Commit `#{refString}` does not exist in Repo")
-    logger.error(e.message)
-    exit
+    logger.error("Searching for commit with ref #{refString} failure: #{e.message}")
+    return nil
   rescue Exception => e
-    puts ("`#{refString}` is not a valid OID")
-    logger.error(e.message)
-    exit
+    logger.error("Searching for commit with ref #{refString} failure: #{e.message}")
+    return nil
   end
 end
 

data/lib/git-releaselog/version.rb

@@ -1,5 +1,5 @@
 module Releaselog
-    VERSION     = "0.7.0"
+    VERSION     = "0.7.1"
     SUMMARY     = "Generate a releaselog from a git repository"
     DESCRIPTION = "Write your releaselog as part of your usual commit messages. This tool generates a useful releaselog from marked lines in your git commit messages"
 end

data/lib/git-releaselog.rb

@@ -8,8 +8,8 @@ module Releaselog
   class Releaselog
     def self.generate_releaselog(options = {})
     repo_path = options.fetch(:repo_path, '.')
-    from_ref_name = options.fetch(:from_ref, nil)
-    to_ref_name = options.fetch(:to_ref, nil)
+    from_ref_name = options.fetch(:from_ref, nil).strip
+    to_ref_name = options.fetch(:to_ref, nil).strip
     scope = options.fetch(:scope, nil)
     format = options.fetch(:format, 'slack')
     generate_complete = options.fetch(:generate_complete, false)
@@ -49,7 +49,7 @@ module Releaselog
       sorted_tags = repo.tags.sort { |t1, t2| t1.target.time <=> t2.target.time }
       changeLogs = []
       sorted_tags.each_with_index do |tag, index|
-        logger.error("Tag #{tag.name} with date #{tag.target.time}")
+        logger.info("Tag #{tag.name} with date #{tag.target.time}")
 
         if index == 0
             # First Interval: Generate from start of Repo to the first Tag
@@ -89,15 +89,17 @@ module Releaselog
         end
       else
         # From which commit should the log be followed? Will default to the latest tag
-        commit_from = (from_ref && from_ref.target) || commit(repo, from_ref, logger) || latest_tag && (latest_tag.target)
+        commit_from = (from_ref && from_ref.target) || commit(repo, from_ref_name, logger) || latest_tag && (latest_tag.target)
+        logger.info("Commit-From: #{commit_from.oid}")
 
         # To which commit should the log be followed? Will default to HEAD
-        commit_to = (to_ref && to_ref.target) || commit(repo, to_ref, logger) || repo.head.target
+        commit_to = (to_ref && to_ref.target) || commit(repo, to_ref_name, logger) || repo.head.target
+        logger.info("Commit-To: #{commit_to.oid}")
 
 
         changes = searchGitLog(repo, commit_from, commit_to, scope, logger)
         # Create the changelog
-        log = Changelog.new(changes, from_ref, to_ref || latest_tag, commit_from, commit_to)
+        log = Changelog.new(changes, from_ref, to_ref, commit_from, commit_to)
 
         # Print the changelog
         case format

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-releaselog
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Markus Chmelar