changelog/generator-configured/python
Changelog generation is configured
Implements changelog/generator-configured for python.
| Severity | info |
| Tiers | 1 |
| Stacks | python |
| Scope | root |
| Kind | outcome |
| Source | library v0.4.0 |
| Selected by | fleetlint-recommended@v0.4.0 |
Requirement
git-cliff, commitizen or towncrier configured in pyproject.toml ([tool.git-cliff], [tool.commitizen], [tool.towncrier]) or towncrier.toml; or a stack-neutral generator.
Why
Hand-written changelogs drift from the commits; generated ones can be trusted and edited.
Fix
Add [tool.towncrier] or [tool.git-cliff] to pyproject.toml, or cliff.toml.
Agent instruction: Add cliff.toml for git-cliff with Conventional Commits groups; fleetlint fix --apply writes the template.
fleetlint fix can apply this rule’s fix automatically (1 action(s)).
Sources
- https://www.conventionalcommits.org/en/v1.0.0/ (standard, Why Use Conventional Commits)
- https://keepachangelog.com/en/1.1.0/ (standard, How do I make a good changelog?)
- https://fleetlint.org/baseline/#releases
- https://towncrier.readthedocs.io/en/stable/ (spec)
- https://commitizen-tools.github.io/commitizen/ (spec)
- https://fleetlint.org/stacks/#python
Generated by fleetlint docs from catalog v0.4.0.