About

History is a history file parser. It can parse common history file layouts and provide the contents in a structured model. This can be useful for a number of things, in particular it can be used to generate tag messages and add pre-release change lists to release announcements.

Example

Given a simple history file, HISTORY.rdoc, as such:

= RELEASE HISTORY

== 0.2.0 / 2011-10-20

This release improves things considerably.

Changes:

* Improves this feature.
* Adds that feature.

== 0.1.0 / 2010-09-04

This is the initial release.

Changes:

* Reworked namespace.
* Spun-off project from that other project.

We can use History to parse the file and query if for specifics.

history = History.new('HISTORY.rdoc')

history[0].version #=> '0.2.0'

Copyright

Copyright (c) 2012 Rubyworks. All rights reserved.

History is distributable in accordance with the BSD-2-Clause license.