Skip to main content

Changelog Generate Troubleshooting

Changelog Generate Troubleshooting

Support Guide

Resolve missing entries, duplicate content, grouping noise, link errors, and template problems.

Commandcusty changelog generate

Category

Changelog

Quick Command

custy changelog generate [OPTIONS]
troubleshootingconfigurationrecovery

Overview​

Most changelog problems originate in release boundaries, local history, commit classification, or render configuration. Diagnose the first unexpected stage before forcing another generation.

A Commit Is Missing​

Check the release boundary, ignore_merge_commits, ignore_types, type mapping, and whether the message matches the configured parser. Also verify that the commit exists in local history.

The Same Entry Appears More Than Once​

Confirm that [tool.custy.changelog.render].deduplicate is enabled and inspect whether pending content repeats a committed message.

Scope Headings Are Noisy​

Review group_by_scope, collapse_generic_scopes, generic_scopes, and the scope map. Generic scopes can be collapsed while meaningful scopes remain.

Pending Content Is Misplaced​

Confirm whether pending content is enabled and inspect the configured message file. The current placement limitation belongs to the changelog subsystem, so see Pending Content for the active provider behavior and loaded-only properties.

Verify repository-link configuration, detected remote information, tags, and the configured release boundaries.

An Alternative Pending Message File Is Rejected​

The --commit-msg-file path must exist and must refer to a file. Resolve the path from the current working directory or use an explicit path. This option selects pending commit content; the changelog Jinja template path comes from project configuration.

Safe Recovery​

Terminal
bash
git diff -- CHANGELOG.md

If the result is not suitable, preserve any needed manual content, correct the input or configuration, and regenerate. Do not discard unrelated working-tree changes.