Requirements

🚀Requirements

Required Review

Prepare repository history, templates, configuration, and file access before generating release notes.

Commandcusty changelog generate

📦Category

Changelog

🚀Quick Command

custy changelog generate

---

requirementsGit historyconfiguration

---

Overview

Changelog generation depends on local repository history and the files selected by the resolved Custy configuration. Confirm these inputs before writing the project changelog.

💡Review repository state first

Use git status and inspect the existing changelog before generation. A clean or understood working tree makes the resulting diff easier to verify.

---

Generation Requirements

📌Requirements

Custy Installation

Required

Custy must be available in the environment used for the intended repository.

Git Repository

Required

Run the command inside the repository whose history should become release notes.

Local History and Tags

Required

Make the relevant commits and release tags available locally so boundaries can be resolved.

Structured Commit Messages

Recommended

Use messages that provide enough type, scope, and breaking-change information for the configured parser.

Pending Message Template

Optional

The configured commit-message template must exist when pending-commit integration is enabled.

Writable Output Path

Required

The process must be able to create or update the configured CHANGELOG.md path.

---

Recommended Preflight

Terminal

bash

git status
git tag --list
custy --dry-run changelog generate

Project configuration is optional because Custy provides defaults, but running custy init first makes templates and behavior easier to inspect and customize.

---

ℹ️Remote access is optional

Remote access is not required for local generation. Remote comparison URLs can still depend on correctly configured repository-link settings.