Metadata-Version: 2.1
Name: changelog-gen
Version: 0.2.3
Summary: Changelog generation tool
Home-page: https://github.com/EdgyEdgemond/changelog-gen/
License: Apache-2.0
Author: Daniel Edgecombe
Author-email: edgy.edgemond@gmail.com
Requires-Python: >=3.5,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: bump2version (>=0.5.11,<0.6.0)
Requires-Dist: click (>=7.0,<8.0)
Project-URL: Repository, https://github.com/EdgyEdgemond/changelog-gen/
Description-Content-Type: text/markdown

# Changelog Generator - v0.2.3

`changelog-gen` is a CHANGELOG generator intended to be used in conjunction
with [bumpversion](https://github.com/c4urself/bump2version) to generate
changelogs and create release tags.

## Installation

```bash
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.

```bash
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.

```bash
$ 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
```

