iv-mexx / git-releaselog Goto Github PK

When generating the Changelog with a to_ref which does not exist as tag, we could assume that that is the name for the next release and thus print the name instead of "Unreleased"

E.g. See https://github.com/iv-mexx/git-releaselog/blob/master/CHANGELOG.md
This Changelog was generated for the release "0.7.0", but before the tag was created (--> The updated changelog should be part of the tag, so the tag needs to be created later than the changelog).

Since git-changelog is already taken on rubygems, it would probably be good to change the project's name rather sooner than later.

Some suggestions to get us started (all of them are available on rubygems), but please feel free to pick whatever you like: gitch, git-releaselog, git-whatsnew

Currently, the Version Header (Current-Tag + Date) is always generated. When using the Changelog in a Github Release Message, the information is redundant, because the version is already a separate attribute of the release.

So, it would be nice to be able to skip the Version Header

The stripping of from_ref_name and to_ref_name from 6b24431 causes errors in case one of them is nil.

For example with the execution of git-releaselog 0.10.0 (without a to_ref, the expectation being that a releaselog is generated from 0.10.0 up to the current commit):

git-releaselog-0.7.1/lib/git-releaselog.rb:12:in `generate_releaselog': undefined method `strip' for nil:NilClass (NoMethodError)

In Rails you could think about handling such cases with NilClass.try?, but I’m not perfectly sure this is how it should be handled here.

When calling git-changelog for my project like this: git-changelog 0.9.0 0.8.0 --format slack it contains a line like the following: Version 0.9.0 (_03.09.2015_)

But 03.09.2015 is in fact the date of the tag 0.8.0. Instead, I would have expected it to pick up the date from the tag 0.9.0, which would be 17.09.2015.

I think the cause may be this line and this line (this should probably be DRYed up by abstracting the information retrieval to a new class for example), which should be str << " (_#{@commit_from.time.strftime("%d.%m.%Y")}_)" (from instead of to) instead.