Skip to content

git-changelog¤

ci documentation pypi version gitpod gitter

Automatic Changelog generator using Jinja2 templates. From git logs to change logs.

Features¤

Installation¤

With pip:

pip install git-changelog

With pipx:

python3.8 -m pip install --user pipx
pipx install git-changelog

Usage¤

git-changelog [--config-file [PATH ...]] [-b] [-B VERSION] [-h] [-i]
              [-g VERSION_REGEX] [-m MARKER_LINE] [-o OUTPUT]
              [-p {github,gitlab,bitbucket}] [-r] [-R] [-I INPUT]
              [-c {angular,conventional,basic}] [-s SECTIONS]
              [-t {angular,keepachangelog}] [-T] [-E] [-Z] [-F FILTER_COMMITS]
              [-V] [--debug-info]
              [REPOSITORY]

Simply run git-changelog in your repository to output a changelog on standard output. To show the different options and their descriptions, use git-changelog -h.