https://github.com/rubyworks/history
HISTORY File Parser
https://github.com/rubyworks/history
Last synced: 11 months ago
JSON representation
HISTORY File Parser
- Host: GitHub
- URL: https://github.com/rubyworks/history
- Owner: rubyworks
- License: other
- Created: 2012-05-24T16:08:46.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2012-12-18T23:52:55.000Z (about 13 years ago)
- Last Synced: 2025-03-03T14:37:21.606Z (12 months ago)
- Language: Ruby
- Homepage: http://rubyworks.github.com/history
- Size: 168 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[Homepage](http://rubyworks.github.com/history) |
[Report Issue](http://github.com/rubyworks/history/issues) |
[Source Code](http://github.com/rubyworks/history)
( [](http://travis-ci.org/rubyworks/indexer) )
# History
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.
## Usage
Basic usage is fairly straight forward. Load a history file using
the `History.at` method.
```ruby
history = History.at('HISTORY.rdoc')
```
Then you have access the the current release with:
```ruby
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:
```ruby
history.releases[i].header
history.releases[i].notes
history.releases[i].version
history.releases[i].date
history.releases[i].codename
history.releases[i].changes
```
## Contact
Need help, want to make a suggestion or just shoot the shit about this whole idea,
try one of these channels.
* [Issue Tracker](http://groups.google.com/groups/rubyworks-mailinglist)
* [Mailing List](http://github.com/rubyworks/history/issues)
* [IRC Channel](irc://us.chat.freenode.net/rubyworks)
## Copyrights
HIstory is copyrighted open source software.
Copyright (c) 2012 Rubyworks
It is distributable and modifiable in accordance with the
[BSD-2-Clause](http://spdx.org/license/bsd-2-clause) license.
See LICENSE.txt file for details.