philiprehberger-changelog-gen
v0.2.01,092 downloadsMIT
Git-based changelog generator from conventional commits
$
pip install philiprehberger-changelog-genREADME
philiprehberger-changelog-gen
Git-based changelog generator from conventional commits.
Installation
pip install philiprehberger-changelog-gen
Usage
Python API
from philiprehberger_changelog_gen import generate_changelog
changelog = generate_changelog(
repo_path=".",
from_tag="v0.1.0",
version="0.2.0",
)
# Print markdown
print(changelog.to_markdown())
# Write to file (prepend to existing)
changelog.write("CHANGELOG.md", mode="prepend")
CLI
# Print to stdout
changelog-gen
# From a specific tag
changelog-gen --from v0.1.0 --version 0.2.0
# Write to file
changelog-gen --output CHANGELOG.md --prepend
Filter by Scope
# Only include commits scoped to "api"
changelog = generate_changelog(scope="api", version="0.2.0")
changelog-gen --scope api --version 0.2.0
Conventional Commits
The generator parses conventional commit messages:
feat: add user authentication
fix(auth): handle expired tokens
feat!: redesign API (breaking change)
chore: update dependencies
Commits are grouped by type: Features, Bug Fixes, Performance, Refactoring, Documentation, Tests, Chores, CI/CD, Build, Style.
Output Example
## 0.2.0 (2026-03-10)
### Breaking Changes
- **api:** redesign authentication flow
### Features
- add user dashboard
- **auth:** add OAuth2 support
### Bug Fixes
- **db:** fix connection pool leak
API
| Function / Class | Description |
|---|---|
generate_changelog(repo_path, from_tag, to_ref, version, include_types, exclude_types, scope) | Generate a changelog from git history between tags/refs |
Changelog | Generated changelog content with to_markdown() and write(path, mode) methods |
CommitEntry | A parsed conventional commit (hash, type, scope, message, breaking, date, author) |
main() | CLI entrypoint for command-line usage |
Development
pip install -e .
python -m pytest tests/ -v
Support
If you find this project useful: