Automatic Changelog generator using Jinja2 templates.
Project description
git-changelog
Automatic changelog generator. From git logs to change logs.
- Installation:
sudo pip3 install git-changelog - Features:
- Jinja2 templates! You get full control over the rendering. Built-in Keep a Changelog and Angular templates (also see Conventional Changelog).
- Commit styles/conventions parsing. Built-in Angular, Atom and basic styles.
- Git service/provider agnostic, plus references parsing (issues, commits, etc.). Built-in GitHub and Gitlab support.
- Understands Semantic Versioning: major/minor/patch for versions and commits. Guesses next version based on last commits.
- Todo:
- Plugin architecture, to support more commit styles and git services.
- Template context injection, to furthermore customize how your changelog will be rendered.
- Easy access to "Breaking Changes" in the templates.
- Update changelog in-place, paired with commits/dates/versions range limitation ability.
Command-line
$ git-changelog --help
usage: git-changelog [-h] [-o OUTPUT] [-s {angular,atom,basic}]
[-t {angular,keepachangelog}] [-v]
REPOSITORY
Command line tool for git-changelog Python package.
positional arguments:
REPOSITORY The repository path, relative or absolute.
optional arguments:
-h, --help Show this help message and exit.
-o OUTPUT, --output OUTPUT
Output to given file. Default: stdout.
-s {angular,atom,basic}, --style {angular,atom,basic}
The commit style to match against.
-t {angular,keepachangelog}, --template {angular,keepachangelog}
The Jinja2 template to use. Prefix with "path:" to
specify the path to a directory containing a file
named "changelog.md".
-v, --version Show the current version of the program and exit.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
git-changelog-0.1.0.tar.gz
(12.2 kB
view hashes)
Built Distribution
Close
Hashes for git_changelog-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 213f930dc2801d598202a28300a9593366aa212a8530811fa9d2f668a3522080 |
|
| MD5 | 42c0dda2a8869d8e83857f1d03d3f980 |
|
| BLAKE2b-256 | 36da026aab58d1653a815ea35d65f2861784003d1eaa9c26b4b67f505f248aac |
