Skip to main content

Overview

Generate a Changelog

Stable

Analyze repository history and render a structured CHANGELOG.md using Custy's changelog configuration.

Commandcusty changelog generate

Category

Changelog

Quick Command

custy changelog generate [OPTIONS]
Git historyrelease notesMarkdown
Category
Changelog
Complexity
Intermediate
Primary Artifact
CHANGELOG.md
Creates Git History
No

Overview​

The command collects eligible commits, parses structured messages, groups and sorts them, applies release behavior, and renders the configured changelog file. It may also incorporate the pending commit-message template when that feature is enabled.

Generation Responsibilities

From History to Markdown

Collect History

Read eligible commits and determine configured release boundaries.

Classify Changes

Parse, clean, deduplicate, group, and sort changelog entries.

Render Releases

Apply release metadata, links, summaries, statistics, and templates.

Write Artifact

Create or update CHANGELOG.md using the resolved generation behavior.

Terminal Preview

Changelog generation

Terminal output from custy changelog generate
The terminal reports changelog generation and the resulting file.

Related Commands

Related Commands

Commands commonly used together with this command.

custy commit

Generate the changelog inside the complete commit profile.

custy run dev

Include changelog generation in daily development work.