Generate a changelog file from a local git checkout
Project description
Generate Changelog
Features
- Configurable to adapt to your changelog preferences.
- Filter out commits and tags based on regular expression matching.
- Classify commit messages into sections such as "New", "Fixes", and "Changes".
- Templated using Jinja templates.
- Rewrite commit summary or commit body using pipelines of actions.
- Supports your merge or rebase workflows and complicated git histories.
- Supports full or incremental changelog generation.
- Parses trailers key values
- Supports of multi-authors for one commit through configurable trailers key values
Requirements
Python 3.8 or higher.
Installation
$ pip install generate-changelog
Usage
Create a default configuration file.
$ generate-changelog --generate-config
This creates a file named .changelog-config.yaml. You can make changes to the default configuration.
Generate your changelog via:
$ generate-changelog
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
generate_changelog-0.7.6.tar.gz
(46.4 kB
view hashes)
Built Distribution
Close
Hashes for generate_changelog-0.7.6-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dc31c14d2ccbf0e796d028337496d6d597f6fc4d8c77ecca91ebb28d84fd9844 |
|
| MD5 | 8592b465c9eedb68c78b1c682d56c743 |
|
| BLAKE2b-256 | 50fe19b8c5d35b64dcfef46667a39c6e1359755d40ecc8ff559d16d4c013c985 |
