Skip to content

A parser for Markdown-formatted changelogs following the keepachangelog.com standard

License

Notifications You must be signed in to change notification settings

colindean/keepachangelog-parser-java

Repository files navigation

keepachangelog parser

This library implements a simple parser for keepachangelog-formatted CHANGELOG.md files. Changelogs tracked in this human-readable format become machine-parseable and thus much more usable for fun things like analysis and involving the changelog in the release build process.

Download Javadocs Build Status

History and Inspirations

This parser is heavily inspired by Vandamme, a Ruby implementation of a keepachangelog parser.

Use it

To us this in your project, include the dependency:

Gradle:

repositories {
  jcenter()
}
dependencies {
    compile group: 'cx.cad.keepachangelog', name: 'changelog-parser', version: '<look it up!>'
}

Maven:

<!-- Ensure that JCenter is already added as a repository. -->
<dependency>
    <groupId>cx.cad.keepachangelog</groupId>
    <artifactId>changelog-parser</artifactId>
    <version><!--look it up! --></version>
</dependency>