Skip to main content

A small command line utility for generating CHANGELOG.md files from GitLab repository commits

Project description

GitLab CHANGELOG Generator

Build Status Code style: black License: MIT

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitlab-changelog-generator-1.0.7.tar.gz (4.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page