Changelog Generator - v0.14.0
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.
1 maintainer
Metadata
1 maintainer
Release files for changelog-gen 0.14.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| changelog_gen-0.14.0.tar.gz | 123.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| changelog_gen-0.14.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 150.6 kB
Release files / changelog_gen-0.14.0.tar.gz
| Download URL | changelog_gen-0.14.0.tar.gz |
|---|---|
| Size | 123.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b4172b5b0de193ce0bfd9891cf060eb4500b2d20a2c49acf3bba43a619999b30
|
|
BLAKE2b-256 checksum How to use checksums |
82452c0d89823d329324a88f8b8a185c038a4e8f678bd08735b4d37663ae1f2f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / changelog_gen-0.14.0-py3-none-any.whl
| Download URL | changelog_gen-0.14.0-py3-none-any.whl |
|---|---|
| Size | 27.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c1d66ebc6b984d89c45ea95cfbadc7ac8678f95b9b6f8a23dd287b8090b18a4a
|
|
BLAKE2b-256 checksum How to use checksums |
705174bbaa0b0e9a1388633ec1f53cced25ac442315ec497285eb327a7241e5a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
