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
File details
Details for the file git_changelog-2.5.0.tar.gz.
File metadata
- Download URL: git_changelog-2.5.0.tar.gz
- Upload date:
- Size: 38.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e968f036fc1311195a72799e3efc8c241a2a36722f9cf94aaa70fe67b3a813b2 |
|
| MD5 | 9fe1a48e27210371eff7f56c3afd2ba5 |
|
| BLAKE2b-256 | 4d9f9cfa2b8c42d84bc2e95d81a480359833fc1b0dc833b669030a9ac7e9100a |
Provenance
File details
Details for the file git_changelog-2.5.0-py3-none-any.whl.
File metadata
- Download URL: git_changelog-2.5.0-py3-none-any.whl
- Upload date:
- Size: 32.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6e08bb65a8108f219589f99a1265a9b8182b15093dcfcfe5b9c181711b3efd91 |
|
| MD5 | f6734a8dbfb1dddebe595f3b5ce5d271 |
|
| BLAKE2b-256 | fdfa1451c30e65df1c312dfc39ee9a46e2c0e1b7c36fef1c0600ae03f8a02bb2 |
