changelog/generator-configured
Changelog generation is configured
| Severity | info |
| Tiers | 1 |
| Stacks | any |
| Scope | root |
| Kind | outcome |
| Source | library v0.6.0 |
| Selected by | fleetlint-recommended@v0.6.0 |
Requirement
The changelog is generated from the commit history, then edited: a stack-neutral generator (git-cliff in cliff.toml, .cliff.toml, [tool.git-cliff] or [workspace.metadata.git-cliff]; GoReleaser, whose changelog is on unless changelog.disable; release-please; cocogitto; semantic-release in .releaserc*, release.config.* or package.json release; commitizen) or the stack’s own (changesets for npm, towncrier for Python), configured in its own file or in the manifest.
Why
Hand-written changelogs drift from the commits; generated ones can be trusted and edited.
Fix
Add cliff.toml; fleetlint fix --apply writes the template.
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)).
A finding of this rule points at cliff.toml.
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://git-cliff.org/docs/configuration (spec)
- https://github.com/changesets/changesets (spec)
- https://towncrier.readthedocs.io/en/stable/ (spec)
- https://fleetlint.org/baseline/#releases
Generated by fleetlint docs from catalog v0.6.0.