Changelog Overview
Changelog Overview
Active Subsystem
Control the complete transformation from Git history and pending content to rendered CHANGELOG.md.
Command
[tool.custy.changelog]Category
Configuration
Quick Command
[tool.custy.changelog.SUBTABLE]Pipeline
Workflow Timeline
1
Collect
Apply core Git-commit eligibility rules.
2
Collect pending content
Optionally add the configured message through PendingCommitProvider, then clean template-oriented text.
3
Build releases
Extract release content and apply per-version overrides.
4
Classify
Apply breaking detection, type mapping, scope mapping, and grouping.
5
Render
Build links and pass the resolved model to the project Jinja template.
Configuration Areas
Features
Core
Choose eligible commits in changelog.core.
Pending Commit
Include pending message content and review loaded-only generation and placement settings in changelog.pending_commit.
Cleaning
Remove presentation-only boilerplate through changelog.cleaning.
Releases
Extract summaries and customize individual versions through release and release_behavior.
Links
Build repository comparison URLs through changelog.links.
Rendering
Control layout, visibility, formatting, sorting, and visual details through changelog.render.
Breaking Changes
Configure keyword detection and labels in changelog.breaking.
Mappings
Map scopes and commit types to reader-facing labels in scope_map and type_map.
Advanced
Review loaded but not yet applied experimental switches in changelog.advanced.
Template Contract
The generated Jinja template uses context.config.rendering,
context.visible_releases(), context.release_label(release),
context.summary_for(release), context.groups_for(release), and
context.tags_for(release). Release objects expose version, date, comparison
URL, title-only state, status, and promoted-from versions.