davidsowerby / changelog

0 stars 0 forks source link

ChangeLog

This project has moved to GitLab

ChangeLog uses Git commit comments and tags from a local repository, combined with issue information from an associated remote repository, to build a change log.

Parameters are highly configurable, and a Velocity template is used to generate the output, enabling the user to modify presentation however they wish.

Example Output

The change log for this project provides an example of the output, but the output is highly configurable

Alternatives

There are quite a few similar projects out there, and the preference would have been to use one that already exists. None of them quite do what was wanted, although in functionality terms this one looked very good. Unfortunately, for our purposes it introduced a dependency on Ruby, for which we have no other purpose. That project also provides a useful list of similar projects.

Download

Not yet available from JCenter or Maven Central

Limitations

Currently only GitHub is supported as a source of issue information. This limitation is actually caused by GitPlus, which is used to manage the interaction with Git)

Use with Gradle

It is intended that this library will also have a Gradle wrapper so that it can be readily invoked as part of a build

Documentation

refer to the user guide for configuration and usage

Language

ChangeLog is written in Kotlin, but published as a Java library. Kotlin is 100% interoperable with Java

Licence

Apache 2.0

Build from source

./gradlew build

Acknowledgements

Thanks to:

Guice
Gradle
Gradle Docker Plugin
Gradle Bintray Plugin
Bintray
Logback
slf4j
spock
FindBugs
Velocity