Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/naoty/ntychangelog

A rubygem to parse CHANGELOGs in my style
https://github.com/naoty/ntychangelog

Last synced: 21 days ago
JSON representation

A rubygem to parse CHANGELOGs in my style

Awesome Lists containing this project

README

        

# NTYChangeLog
[![Gem Version](https://badge.fury.io/rb/nty_change_log.svg)](https://badge.fury.io/rb/nty_change_log)

```markdown
# Change Log

## 1.0.1

### Changed
* Change the name of this rubygem. [#3](https://github.com/naoty/nty_change_log/pull/3)
* Divide a large methods into some small methods. [#3](https://github.com/naoty/nty_change_log/pull/3)

### Fixed
* Fix some bugs. [#3](https://github.com/naoty/nty_change_log/pull/3)

## 1.0.0

### Added
* Parse change groups. [#2](https://github.com/naoty/nty_change_log/pull/2)
* Parse change logs in my style. [#1](https://github.com/naoty/nty_change_log/pull/1)
```

## Usage

```ruby
require "nty_change_log"

text = File.read("./CHANGELOG.md")
change_log = NTYChangeLog::Parser.new.parse(text)

version = change_log.versions.first
version.name #=> "1.0.1"

change_group = version.change_groups.first
change_group.label #=> "Change"

change = change_group.changes.first
change.description #=> "Change the name of this rubygem."
change.issue.number #=> 3
change.issue.url #=> "https://github.com/naoty/nty_change_log/pull/3"
```

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).