Configuration

Advanced

Configure changelog collection, cleaning, grouping, links, release behavior, and Markdown rendering.

Commandcusty changelog generate

Quick Command

custy changelog generate

configurationTOMLrendering

Overview

Custy reads project settings from .config/custy/config.toml. Changelog-related settings are separated by responsibility so teams can adjust collection and presentation behavior independently.

Configuration Tables

Changelog Configuration Groups

TOML tables used by changelog generation.

Property	Type	Description	Default	Required
`[tool.custy.cli.changelog]`	CLI behavior	Configure command-level behavior such as force_generation.	-	No
`[tool.custy.cli.templates.file]`	Paths	Select changelog and commit-message template paths.	-	No
`[tool.custy.changelog.core]`	Collection	Control eligible commits, ignored merge commits, and ignored types.	-	No
`[tool.custy.changelog.pending_commit]`	Active + loaded only	Enable pending-message collection; generation mode and placement are loaded but not applied by the active generator.	-	No
`[tool.custy.changelog.cleaning]`	Presentation	Remove configured template-only content before rendering.	-	No
`[tool.custy.changelog.release]`	Release behavior	Configure release recognition and release-level behavior.	-	No
`[tool.custy.changelog.release_behavior]`	Overrides	Define version-specific release overrides.	-	No
`[tool.custy.changelog.links]`	Links	Configure repository, release, and comparison URL generation.	-	No
`[tool.custy.changelog.render]`	Rendering	Control titles, summaries, metadata, grouping, empty sections, statistics, and footer presentation.	-	No
`[tool.custy.changelog.breaking]`	Classification	Configure breaking-change handling.	-	No
`[tool.custy.changelog.scope_map]`	Display mapping	Map commit scopes to their displayed labels.	-	No
`[tool.custy.changelog.type_map]`	Display mapping	Map and order commit types in the rendered changelog.	-	No
`[tool.custy.changelog.advanced]`	Experimental	Configure experimental changelog behavior.	-	No

Example Configuration

.config/custy/config.toml

toml

[tool.custy.cli.changelog]
force_generation = false

[tool.custy.changelog.core]
ignore_merge_commits = true
ignore_types = ["chore"]

[tool.custy.changelog.pending_commit]
enabled = true
generation = "regenerate"
placement = "before"

[tool.custy.changelog.render]
group_by_scope = true
deduplicate = true
show_compare_link = true

Detailed Property Reference

This command page summarizes the tables involved in generation. The dedicated Changelog Configuration guide documents every property, generated default, supported value, implementation status, and interaction with the project Jinja template.

Related Commands

Commands commonly used together with this command.

Core Collection

Configure ignored merge commits and commit types.

Release Processing

Configure extraction and per-version behavior.

Rendering

Review all 28 rendering properties.

All Configuration Properties

Search the complete Custy configuration index.

Overview​

Overview