gitchangelog

3.0.4 verified Fri May 01 auth: no python

gitchangelog generates a changelog from git log messages. It uses a configurable template system to produce release notes. Latest version: 3.0.4. Release cadence: irregular.

pip install gitchangelog

Common errors

error gitchangelog: error: the following arguments are required: output ↓

cause gitchangelog expects at least one argument (the output file or '--stdout').

fix

Run 'gitchangelog --stdout' or 'gitchangelog CHANGELOG.rst'

error ImportError: No module named gitchangelog ↓

cause gitchangelog is not installed or not in the Python path.

fix

Install via pip: 'pip install gitchangelog'

Warnings

breaking gitchangelog 3.x changed the template engine to use Mako instead of custom templates. Existing .gitchangelog.rc templates may break. ↓

fix Update .gitchangelog.rc to use Mako syntax. See migration guide at https://github.com/vaab/gitchangelog#migration-from-v2-to-v3

gotcha gitchangelog requires a .gitchangelog.rc file in the project root. Without it, it uses a default template that may not produce expected output. ↓

fix Create a .gitchangelog.rc file or use -c to specify a config file.

deprecated Python 2 support was dropped in version 3.0.0. ↓

fix Use Python 3.6 or later.

Imports

main
wrong
```
import gitchangelog
```
correct
```
from gitchangelog import main
```
gitchangelog is a script; importing the module directly calls main. Correct import is for programmatic use.

Quickstart

Generates a changelog by reading git log and outputting to stdout. Works only in a git repository.

# Generate changelog from git log
from gitchangelog import main
import sys
sys.argv = ['gitchangelog']
main()