Rendering

🚀Rendering

Active + Loaded-Only Fields

Control the final Markdown layout while distinguishing active template behavior from loaded-only fields.

Command[tool.custy.changelog.render]

📦Category

Changelog Configuration

🚀Quick Command

[tool.custy.changelog.render]

---

visibilitylayoutsorting

---

📋

Properties

28

📁

Groups

5

📄

Template

changelog.j2

⚠️

Loaded-Only

Documented below

General Visibility

📋Properties

Property	Type	Description	Default	Required
show_title	Boolean	Render the main Changelog heading. Active in the generated Jinja template.	true	No
show_description	Boolean	Render the introductory description. Active in the template.	true	No
show_release_status	Boolean	Render a release label when status is available. Active.	true	No
show_summary	Boolean	Render the resolved release summary. Active.	true	No
show_promoted_from	Boolean	Render pre-release versions promoted into the release. Active.	true	No
show_compare_link	Boolean	Display a comparison URL when link generation produced one. Active.	true	No

Layout and Empty Content

📋Properties

Property	Type	Description	Default	Required
group_by_scope	Boolean	Create scope subsections within commit-type groups. Active.	true	No
collapse_generic_scopes	Boolean	Avoid subsections for scopes that provide little additional meaning. Active.	true	No
generic_scopes	String array	Scope names treated as generic after scope mapping. Active and normalized to lowercase.	8 generated values	No
deduplicate	Boolean	Remove overlapping changelog entries during processing and context construction. Active.	true	No
show_empty_sections	Boolean	Loaded into the rendering model but not consulted by the current active template or context.	false	No
show_empty_groups	Boolean	Keep empty commit-type groups in render context. Active.	false	No
show_empty_scopes	Boolean	Keep empty scope subsections. Active.	false	No
show_empty_metadata	Boolean	Loaded only; the current generated template has no metadata section.	false	No
show_empty_tags	Boolean	Render an empty Tags section when show_tags is enabled. Active.	false	No

Generated generic scopes

toml

generic_scopes = [
"", "main", "core", "general",
"default", "root", "changelog", "release",
]

Optional Sections

📋Properties

Property	Type	Description	Default	Required
show_metadata	Boolean	Loaded only; the current generated template does not render a metadata block.	true	No
show_tags	Boolean	Render grouped release tags. Active.	true	No
show_contributors	Boolean	Loaded only and marked as a future feature in the generated configuration.	false	No
show_statistics	Boolean	Loaded only and marked as a future feature in the generated configuration.	false	No

Formatting

📋Properties

Property	Type	Description	Default	Required
bullet	String	Character or string placed before rendered items. Active.	-	No
indent	Non-negative integer	Leading spaces before list items. Invalid negative values fall back to 0. Active.	0	No
blank_lines_between_releases	Non-negative integer	Loaded only; spacing is currently controlled by Jinja template structure.	2	No
blank_lines_between_commit_groups	Non-negative integer	Loaded only; spacing is currently controlled by Jinja template structure.	1	No

Sorting and Visuals

📋Properties

Property	Type	Description	Default	Required
sort_groups	Boolean	Sort commit-type groups alphabetically instead of preserving mapped order. Active.	false	No
sort_scopes	Boolean	Sort scope subsections alphabetically. Active.	true	No
sort_items	Boolean	Sort individual entries alphabetically. Active.	false	No
show_section_icons	Boolean	Keep or strip icon prefixes from mapped section titles. Active.	true	No
show_footer	Boolean	Render the Generated by Custy footer. Active in the generated template.	false	No

⚠️Loaded does not always mean visible

The resolver accepts every property above, but the current generated template does not apply metadata, contributors, statistics, global empty-section, or blank-line controls. Those fields are documented as loaded only rather than presented as working output switches.

Review Workflow

Change one rendering group at a time, run custy changelog generate, and inspect both the rendered Markdown and its Git diff. Template customization can also change which rendering fields have a visible effect.

Continue

🚀Related Commands

Commands commonly used together with this command.

Mappings

Configure the labels sorted and rendered here.

Links

Configure comparison URL generation.

Generated Output

Review expected Markdown structure.

Troubleshooting

Diagnose missing or unexpected sections.