Skip to main content

Changelog generation tool

Project description

Changelog Generator - v0.11.0

image image image style tests codecov

Details

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

See the docs for more details.

Usage

changelog init will generate an empty changelog with changelog init if you have not been maintaining changelogs previously. If you already have a changelog file, it will be detected.

changelog generate will extract all commits matching the conventional format since the last release, detect the correct semver release, and generate the correct changelog entry. Depending on configuration, it will also tag the release.

Migrating from 0.8 to 0.9 (Conventional Commit support)

Check the discussion here for details on how to update usage to maintain legacy functionality or move over to new features.

Installation

pip install changelog-gen

or clone this repo and install with invoke/poetry.

invoke install-dev

Contributing

This project uses pre-commit hooks, please run invoke install-dev after cloning to install dev dependencies and commit hooks.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelog_gen-0.11.0.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

changelog_gen-0.11.0-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

Details for the file changelog_gen-0.11.0.tar.gz.

File metadata

  • Download URL: changelog_gen-0.11.0.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1022-azure

File hashes

Hashes for changelog_gen-0.11.0.tar.gz
Algorithm Hash digest
SHA256 f247b03c20108527cb287a19cbe7ebd3cbedd070f463c3e48c632a3c37854cdc
MD5 5d9a349aabbc1a06d27bb57aa420b70b
BLAKE2b-256 ae99b9f2507fafa096b3b2732f76cffa2c3643e55fbd3c3fa821f915101773e5

See more details on using hashes here.

File details

Details for the file changelog_gen-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: changelog_gen-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 21.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1022-azure

File hashes

Hashes for changelog_gen-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a82c9a4f4d9d6a72e713541a80629b22739e9b498caec15260028180870675af
MD5 41f0842b1913b3d485adf7d9badb71c2
BLAKE2b-256 88912186b4e9deddc65b6b64e6a8f97fa473c368a6fbd64d2d09e7e139fe74cb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page