Skip to main content

Changelog generation tool

Project description

Changelog Generator - v0.2.3

changelog-gen is a CHANGELOG generator intended to be used in conjunction with bumpversion to generate changelogs and create release tags.

Installation

pip install changelog-gen

or clone this repo and install with poetry, currently depends on poetry < 1.0.0 due to other personal projects being stuck.

poetry install

Usage

changelog-gen currently only supports reading changes from a release_notes folder.

Files in the folder should use the format {issue_number}.{type}, supported types are currently fix and feat. The contents of the file is used to populate the changelog file.

$ changelog-gen

## v0.2.3

### Bug fixes

- Raise errors from internal classes, don't use click.echo() [#4]
- Update changelog line format to include issue number at the end. [#7]

Write CHANGELOG for suggested version 0.2.3 [y/N]: y

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 changelog-gen, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size changelog_gen-0.2.3-py3-none-any.whl (11.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size changelog_gen-0.2.3.tar.gz (9.4 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