GitLab CHANGELOG Generator

Description

A simple command line utility to produce a CHANGELOG.md file from the commit differences between two GitLab project branches.

Python 3.6 or Python 3.7 are required to run this utility.

Installation

This utility can be installed through pip by running the following command:

pip install gitlab-changelog-generator

Usage

changegen --ip localhost --group test-projects --project test-project --branches master release --version 1.1

Tests

Tests for this project utilise the Pytest framework. To run the existing suite of unit tests run the following command within the root directory:

pytest

Notes

All Python code has been formatted by Black, 'the uncompromising Python code formatter'.

Type checking has been provided by Pyre.

Continuous integration is handled by Travis CI.

License

See LICENSE.md.