Output

🚀Command Output

Review Required

Understand the generated CHANGELOG.md structure and the checks required before committing it.

Commandcusty changelog generate

📦Category

Changelog

🚀Quick Command

custy changelog generate

---

outputMarkdownreview

---

Overview

The primary artifact is CHANGELOG.md. Its exact structure depends on available history, release boundaries, templates, and render configuration.

---

Console Progress

Custy displays a determinate Rich progress bar while collecting changelog history. The total contains one unit for Unreleased and one unit for every discovered Git tag. The visible description changes from Processing Unreleased changes to Processing release TAG as each range is collected.

💻Command Output

Example output produced after running the command.

History Collection

Representative progress for a repository with two tags.

Terminal

text

Processing Unreleased changes   ━━━━━━━━━━━━━ 1/3
Processing release v2.0.0-rc.1 ━━━━━━━━━━━━━ 2/3
Generating changelog ✔          ━━━━━━━━━━━━━ 3/3

---

💡Notes

The exact display, timing, and tags depend on the current terminal and repository.

Changelog generation progress

The progress bar reports Unreleased content and each discovered release range.

ℹ️Progress completion is not a write confirmation

The bar tracks history collection. Release behavior, sorting, rendering, and the final output decision happen afterward. In dry-run mode, Custy still shows the progress and renders a preview, but it does not replace CHANGELOG.md.

---

Representative Structure

💻Command Output

Example output produced after running the command.

Generated Changelog

A representative outline; actual headings and groups follow project configuration.

Terminal

text

# Changelog

## v1.4.0 - 2026-08-12

### Features

- Add structured release metadata

### Bug Fixes

- Preserve configured changelog grouping

---

💡Notes

Release titles, dates, sections, links, and metadata can differ by repository.

---

Possible Content

Depending on configuration and available history, the file can contain:

• A changelog title and description.
• Releases ordered by version and date.
• Release status, summary, metadata, and promoted pre-releases.
• Comparison and release links.
• Commit groups such as features, fixes, performance, documentation, or tests.
• Optional scope subsections.
• Contributors, statistics, tags, breaking changes, and footer content.

---

Generated File Preview

Generated changelog

The generated Markdown is grouped and rendered according to project configuration.

---

⚠️Always review the diff

Generation is deterministic from the available inputs and configuration, but the result still represents release communication. Check version boundaries, grouping, links, pending content, and unexpected omissions before committing.