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 (https://www.conventionalcommits.org) to read and scope commits. Markdown is used for formating.
Commands
$ pychangelog generate [<path>] [--types=<list>] [--bodytags=<list>]
- generates new CHANGELOG.md file at repo root
- overrides old CHANGELOG.md
$ pychangelog add [<path>] [--types=<list>] [--bodytags=<list>]
- ceeps the content of the old CHANGELOG.md while adding new version logs
$ pychangelog printout [<path>] [--types=<list>] [--bodytags=<list>]
- prints the generated changelog in terminal instead of writing it in the CHANGELOG.md
- does not touch the CHANGELOG.md
Options
Option | Format | Description | Default |
---|---|---|---|
path | TEXT | path to root of the git repository | . |
--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.2.0.tar.gz
(4.7 kB
view hashes)
Built Distribution
Close
Hashes for python_changelog-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88c3556791aecab682c8b22b3a6238ab983fbd4669ad6b8d961b0c52d788827b |
|
MD5 | 89d38d011638c68fe56aa99c141db25e |
|
BLAKE2b-256 | 999ad78c63e49c73c7c659706f0b663b3e6e4fb510e3e56dab670de37cac50e0 |