Skip to main content

Workflow

Generation Workflow

Stable

Follow the changelog pipeline from resolved inputs and Git history to rendered Markdown.

Commandcusty changelog generate

Category

Changelog

Quick Command

custy changelog generate [OPTIONS]
workflowpipelinerendering

Overview​

The generator resolves configuration once, transforms repository history into structured releases, and writes the resulting Markdown artifact only after the content is ready to render.

Workflow Timeline

Changelog Generation

The high-level responsibilities executed by the changelog pipeline.

1
Resolve inputs
Combine CLI overrides, project configuration, and defaults.
completed
2
Collect history
Read eligible Git commits and determine release boundaries.
completed
3
Report collection progress
Advance once for Unreleased content and once for every discovered Git tag.
completed
4
Parse and clean
Parse structured messages and remove configured presentation-only content.
completed
5
Group and sort
Organize entries by release, type, scope, and configured ordering.
completed
6
Integrate pending content
Include the pending commit template when enabled.
optional
7
Render Markdown
Apply release behavior, links, metadata, statistics, and template settings.
completed
8
Write or preview CHANGELOG.md
Create or update the artifact during normal execution, or display rendered content without writing during dry-run.
completed

Failure Behavior

If collection, parsing, template resolution, or rendering fails, correct that stage before rerunning the generator. Inspect the working-tree diff to determine whether an earlier changelog artifact already exists.