auto-changelog

Table of Contents

• auto-changelog
  • Table of Contents
  • About
  • Getting Started
    • Prerequisites
    • Installation
      • CLI Application
      • API
  • Usage
    • CLI
  • Testing
  • Contributing
  • Owners

About

auto-changelog is a small application that automates creation of changelogs for software projects based on git commits. It:

• Determines the version number based on the git tags in the repository
• Parses the commit log from the last version to determine the commit/release range to generate change logs for
• Generates the changelog from those commits

Getting Started

Prerequisites

This application requires Java 17 or later. In addition, auto-changelog must be run in a directory with an initialized git repository.

Installation

CLI Application

The latest version can be downloaded from Elhub's internal artifactory under elhub-bin/auto-changelog/.

To build the current version, run:

./gradlew assemble

To publish the executable jar to artifactory, run:

./gradlew publish

API

Add the library to dependencies.

Gradle:

implementation("no.elhub.devxp:auto-changelog-core:$version")

Maven:

<dependency>
  <groupId>no.elhub.devxp</groupId>
  <artifactId>auto-changelog-core</artifactId>
  <version>${version}</version>
</dependency>

Usage

CLI

java -jar auto-changelog-cli.jar --help

Testing

The full suite of tests can be run using:

./gradlew test

Contributing

Contributing, issues and feature requests are welcome. See the Contributing file.

Owners

This project is developed by Elhub. For the specific development group responsible for this code, see the Codeowners file.