Skip to main content

Changelog generation tool

Project description

Changelog Generator - v0.13.8

uv ruff image image image style tests codecov

Details

changelog-gen is a CHANGELOG generator, to detect semantic versioning changes from conventional commits, and generate release tags.

See the docs for more details.

Usage

changelog init will generate an empty changelog file 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 semantic version component to increment, and generate the correct changelog entry. Depending on configuration, it will also update release tags in files as well as tagging the release.

$ git log --oneline
a4e1449 feat: Open changes in editor before confirmation, to allow modification.
c314b6b feat: Block generation if local/remote are out of sync.
2e25deb chore: Relax typer version to 0.X
a95fd80 fix: Handle warning message from bump-my-version if setup.cfg exists
b46d2fe fix: Clean up link generation format in MDWriter

Using the above commits, can generate the following example changelog entry.

# Changelog

## v0.9.2 - 2024-03-08

### Features and Improvements
- Open changes in editor before confirmation, to allow modification. [[#1](https://github.com/NRWLDev/changelog-gen/issues/1)] [[a4e1449](https://github.com/NRWLDev/changelog-gen/commit/a4e1449bf44f370c671cc679d4bf9cfd75e68cbf)]
- Block generation if local/remote are out of sync. [[#2](https://github.com/NRWLDev/changelog-gen/issues/2)] [[c314b6b](https://github.com/NRWLDev/changelog-gen/commit/c314b6b8a32f4ce5c05869f0accd24bb4e6097f2)]

### Bug fixes
- Handle warning message from bump-my-version if setup.cfg exists [[a95fd80](https://github.com/NRWLDev/changelog-gen/commit/a95fd80d939985ab4b51a864676dda234e345d47)]
- Clean up link generation format in MDWriter [[b46d2fe](https://github.com/NRWLDev/changelog-gen/commit/b46d2fe6fba5a170f25dffbf8697868d14a4e73e)]

### Miscellaneous
- Relax typer version to 0.X [[2e25deb](https://github.com/NRWLDev/changelog-gen/commit/2e25deb902710343a0f85f40323762752eef4a45)]

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/uv.

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.13.8.tar.gz (110.1 kB view details)

Uploaded Source

Built Distribution

changelog_gen-0.13.8-py3-none-any.whl (27.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: changelog_gen-0.13.8.tar.gz
  • Upload date:
  • Size: 110.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for changelog_gen-0.13.8.tar.gz
Algorithm Hash digest
SHA256 70a451ad1371fa6b7f256cc0861f113a2852376970a2a04bcbaa228de9860db2
MD5 050274df36e5240acdb74756aa92d003
BLAKE2b-256 4662b290b38fdb74c617d5f952df15df7c156cbda9a3308df9eb53e176078af8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: changelog_gen-0.13.8-py3-none-any.whl
  • Upload date:
  • Size: 27.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for changelog_gen-0.13.8-py3-none-any.whl
Algorithm Hash digest
SHA256 2fff705e8f0f35cb7d134a09a127ee14e1bd5443dd3e4e41f0dd6f575e209920
MD5 4d91978abbb6b99b0cad5d6780100e7a
BLAKE2b-256 4554edc02732e8d18a2ee0aca5b65770f61da783a14a12ac23ac939671c8da15

See more details on using hashes here.

Supported by

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