Changelog generation tool
Project description
Changelog Generator - v0.3.0
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. If the type ends with a !
it denotes a breaking change has been
made, this will lead to a major release being suggested.
$ changelog-gen
## v0.3.0
### 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.3.0 [y/N]: y
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for changelog_gen-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94c1028862056817e96f1d379045efc334fdfa4eb6a31cf3f1d103dfd20d2857 |
|
MD5 | e42e084f20c74c84fa4b241d4a2a6dcf |
|
BLAKE2b-256 | fd662c9c8007b74440e6f833e6390442e6d6505839a40ab3eb97d06b68b4881f |