A simple ChangeLog generator from a git repository
Ruby
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
CHANGELOG
LICENSE
README.md
Rakefile
changelogger.gemspec

README.md

ChangeLogger

ChangeLogger is a simple ChangeLog generator from a git repository.

Requirements

  • git. Tested with 1.8.1

Installation

RubyGems

Make sure you have gem installed, and just run:

$ gem install changelogger

Source

Clone this repo and build the gem:

$ git clone git://github.com/jcazevedo/changelogger.git
$ gem build changelogger.gemspec
$ gem install changelogger-0.0.3.gem

Usage

ChangeLogger publishes a changelogger binary which you can run inside a git repository, or pointing to a git repository through the first argument of its changelog task in order to produce a changelog to the stdout:

$ changelogger changelog ~/work/changelogger

If you want to save the output to a file, simply redirect the output:

$ changelogger changelog ~/work/changelogger > CHANGELOG

Since the top commit of the current HEAD of the repository might not yet be tagged, the --top_version option allows you to supply a string to be used as the top version of the ChangeLog:

$ changelogger changelog ~/work/changelogger --top_version v0.0.3

Copyright

Copyright (c) 2013 Joao Azevedo. See LICENSE for details.