A module that generates changelogs based on git tags.
Project description
Changelog Generator
A module that generates changelogs based on git tags. It uses conventional commits (conventionalcommits.org) to read and scope commits. Markdown is used for formating.
Commands
$ pychangelog generate [<path>] [--branch=<string>] [--types=<list>] [--bodytags=<list>]
- generates new CHANGELOG.md file at the repo root
- overrides old CHANGELOG.md
$ pychangelog add [<path>] [--branch=<string>] [--types=<list>] [--bodytags=<list>]
- keeps the content of old CHANGELOG.md while appending new versions
$ pychangelog printout [<path>] [--branch=<string>] [--types=<list>] [--bodytags=<list>]
- prints the generated changelog in the terminal instead of writing it in the CHANGELOG.md
- does not touch CHANGELOG.md
Options
Option | Format | Description | Default |
---|---|---|---|
path | TEXT | path to root of the git repository | . |
--branch | TEXT | git branch | main |
--types | TEXT comma seperated list | commit types to show in changelog | feat,fix,chore,docs,refactor,test |
--bodytags | TEXT comma seperated list | body tags that schould be shown in changelog | BREAKING CHANGE,MAJOR |
Instalation
You can install the changelog generator via PyPI:
pip install python-changelog
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
python-changelog-0.3.3.tar.gz
(5.7 kB
view hashes)
Built Distribution
Close
Hashes for python_changelog-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a11b9f4d9726eb47a36b63b78e60efeebe7f24785fffede61bd97eb29865790 |
|
MD5 | d8123bca292f8c3a9157ad69b493fcd5 |
|
BLAKE2b-256 | 91fabd6f2547644fa7d7ea13d55c9308af047c3d99ddf6a822a628d276d43164 |