Examples

🚀Examples

Stable

Use practical generation patterns for previews, forced rebuilds, and one-time template overrides.

Commandcusty changelog generate

📦Category

Changelog

🚀Quick Command

custy changelog generate [OPTIONS]

---

examplesdry-runrelease notes

---

Overview

Start with normal generation for established project configuration. Use dry-run or an explicit override when reviewing a new repository or changing generation behavior.

💡Preview configuration changes

Run the dry-run form after changing changelog configuration, then inspect the normal CHANGELOG.md diff before committing it.

---

Common Examples

📝Examples

Practical command examples.

Generate with project configuration

Use the repository's configured templates, collection rules, and render settings.

CLI

custy changelog generate

---

✅Expected Result

CHANGELOG.md is generated or updated from the resolved repository history.

Preview generation

Inspect planned execution through the root dry-run option.

CLI

custy --dry-run changelog generate

---

💡Notes

Confirm dry-run output before normal execution when changing configuration.

Rebuild existing content

Request forced regeneration using current history and configuration.

CLI

custy changelog generate --force

---

💡Notes

Review the complete changelog diff because more content may be replaced.

Use a release-specific pending message

Override the pending commit-message source for one invocation.

CLI

custy changelog generate --commit-msg-file .config/custy/templates/release-commit.txt

---

⚠️Forced generation is broader

--force can rebuild more existing content than a normal incremental run. Review the complete artifact rather than only the newest release section.