Skip to main content

Changelog

Changelog Commands

Stable

Generate structured release notes and maintain CHANGELOG.md from repository history and project configuration.

Commandcusty changelog

Category

Release Documentation

Quick Command

custy changelog COMMAND
changelogrelease notesGit history
Category
Release Documentation
Public Subcommands
1
Primary Artifact
CHANGELOG.md
Modifies Git History
No

Overview​

Custy builds structured release notes from Git history, release boundaries, Conventional Commit-style messages, project configuration, and an optional pending commit message.

Available Command

Changelog Operations

Generate CHANGELOG.md

Use custy changelog generate to collect eligible history and render the configured changelog artifact.

Organize Release Notes

Group entries by release, commit type, and optional scope while preserving configured ordering.

Control Presentation

Configure links, summaries, metadata, statistics, pending content, and footer behavior in the project configuration.

How Generation Works

The generator can group entries by type and scope, integrate a pending commit, clean template-only content, remove duplicates, render release metadata, and build comparison links. The exact result is controlled by the project's Custy configuration.

Related Commands

Related Commands

Commands commonly used together with this command.

custy commit

Run the commit profile, which includes changelog generation.