Generate changelog based on tags, issues and merged pull requests on GitHub.


Keywords
Automatic changelog generation
License
MIT
Install
pip install pygcgen==0.2.4

Documentation

pygcgen

Automaticaly generate a changelog based on GitHub issues and pull requests. For each tag there will be a section with closed issues and merged pull requests. Also there can be user defined sections based on labels.

Status

PyPI Python Version PyPI Version PyPI Status Travis Build Status Code Climate Status Code Climate Issue Count Test Coverage RTD Documentation Status

Installation

pygcgen is available on PyPi: pip install pygcgen or from source: python setup.py install

A command line tool will be installed into the python/Scripts path.

Usage

In your repository root dir: pygcgen or python -m pygcgen. From elsewhere: pygcgen --user topic2k --project pygcgen or pygcgen -u topic2k -p pygcgen.

Info
GitHub has a rate limit. Unauthenticated requests are limited to 60 requests per hour. To make authenticated requests, provide a token with --token <your-40-digit-token> or -t <your-40-digit-token>

Example output

pygcgen's own changelog is generated with itself: CHANGELOG.md

Credit

pygcgen was born as a conversion from Ruby to Python of skywinder's GitHub Changelog Generator