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.

History and Inspirations

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

Use it

To use this in your project, include the dependency:

Gradle

dependencies {
    implementation: 'cx.cad.keepachangelog:changelog-parser:<look it up!>'
}

Until this is re-released onto a normal repository, you'll also need to add this in settings.gradle:

sourceControl {
    gitRepository("https://github.com/colindean/keepachangelog-parser-java.git") {
        producesModule("cx.cad.keepachangelog:changelog-parser")
    }
}

Maven

Until this is re-released onto a normal repository, this uses JitPack for packaging. Note that while the dependency coordinates are com.github.colindean:keepachangelog-parser-java, the import path is cx.cad.keepachangelog.

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.colindean</groupId>
    <artifactId>keepachangelog-parser-java</artifactId>
    <version><!--look it up! --></version>
</dependency>