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 Semantic Versioning: major/minor/patch for versions and commits. 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.
-
Todo:
- Plugin architecture, to support more commit conventions and git services.
- Template context injection, to furthermore customize how your changelog will be rendered.
- Easy access to "Breaking Changes" in the templates.
- Commits/dates/versions range limitation ability.
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.
- 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.4.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | faac569e4f671ff81ccda49b07081bbfb7a4e78374b27a65c3ea80678e01b41b |
|
| MD5 | 3470d9e20c5f0e62c9254f42021aaa69 |
|
| BLAKE2b-256 | 6e1b48664da5a1edc96818e4b8a42d27e22c089c669fb688a5bb94ac104aea06 |
