Automatic Changelog generator using Jinja2 templates.
Project description
git-changelog
Automatic Changelog generator using Jinja2 templates. From git logs to change logs.
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, Conventional Commit and basic conventions.
-
Git service/provider agnostic, plus references parsing (issues, commits, etc.). Built-in GitHub, Gitlab and Bitbucket support.
-
Understands SemVer and PEP 440 versioning schemes. Guesses next version based on last commits.
-
Parses Git trailers, allowing to reference issues, PRs, etc., in your commit messages in a clean, provider-agnostic way.
-
Template context injection, to furthermore customize how your changelog will be rendered.
-
Todo:
- Plugin architecture, to support more commit conventions and git services.
- Easy access to "Breaking Changes" in the templates.
Installation
With pip:
pip install git-changelog
With pipx:
python3.8 -m pip install --user pipx
pipx install git-changelog
Usage
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.
- See Quick usage for some command line examples.
- See Configuration to learn how to configure git-changelog for your project.
- See the CLI reference and the API reference for more information.
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
Built Distribution
Hashes for git_changelog-2.5.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 82eca31bd80fbd85e6b252fece82fe450706a7796b92c9d2c7f17c5944fe9ca7 |
|
| MD5 | 197804c11b5706de02b746d19f331003 |
|
| BLAKE2b-256 | 539d09550219982499783e9fe228a2feeb658a964d06376bfd1a537cfb236e08 |
