Skip to main content

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.

Files for python-changelog, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size python_changelog-0.2.0-py3-none-any.whl (7.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size python-changelog-0.2.0.tar.gz (4.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page