History

ARCHIVED. History is an old-school idea from a time when hand-curated HISTORY / CHANGES files were the primary record of a project's evolution. Over the years Git commits themselves have effectively become the history log, and in the age of AI-assisted development the need to parse free-form HISTORY files programmatically has all but vanished. Preserved here as a historical curiosity. No further development is planned.

Source Code

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.

Basic usage is fairly straight forward. Load a history file using the History.at method.

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

Then you have access the the current release with:

    history.release.header
    history.release.notes
    history.release.version
    history.release.date
    history.release.codename
    history.release.changes

And all releases with with an index:

    history.releases[i].header
    history.releases[i].notes
    history.releases[i].version
    history.releases[i].date
    history.releases[i].codename
    history.releases[i].changes

Need help, want to make a suggestion or just shoot the shit about this whole idea, try one of these channels.

• Issue Tracker
• Mailing List
• IRC Channel

HIstory is copyrighted open source software.

Copyright (c) 2012 Rubyworks 

It is distributable and modifiable in accordance with the BSD-2-Clause license.

See LICENSE.txt file for details.