FAQ

🚀Frequently Asked Questions

Support Guide

Find concise answers about changelog side effects, public command forms, commit formats, and configuration.

Commandcusty changelog generate

📦Category

Changelog

🚀Quick Command

custy changelog generate

---

FAQrelease notessupport

---

Overview

These answers clarify the boundaries of standalone changelog generation and the project settings that affect its result.

ℹ️Use the direct command

The supported standalone form is custy changelog generate. The internal changelog profile is not a public custy run argument.

---

Does Generation Change Git History?

No. The standalone command writes the changelog file but does not itself create a commit or tag. A larger public profile may perform those later stages.

---

Can I Run `custy run changelog`?

No. changelog is currently an internal profile name, not an accepted public custy run argument. Use custy changelog generate.

---

Must Every Commit Use Conventional Commits?

Structured messages give the parser the most reliable type, scope, and breaking change information. Unstructured messages may be classified differently or excluded depending on configuration.

---

Will `--force` Ignore All Configuration?

No. It changes the force-generation decision; collection, parsing, grouping, release, link, and rendering settings still apply.

---

How Do I Generate a Changelog from Git History Only?

In your project's .config/custy/config.toml, set enabled = false in the existing pending-commit section:

Exclude the pending message

toml

[tool.custy.changelog.pending_commit]
enabled = false

Then run custy changelog generate as usual. You do not need to delete or empty commit-message.txt; it remains available for commit operations. Messages already committed to Git can still appear through history, subject to your changelog filters.

See Pending Commit configuration for the setting comparison and regeneration example.

---

Can I Keep Manual Content in `CHANGELOG.md`?

That depends on the selected generation and integration behavior. Test the configuration on a reviewed branch and inspect the full diff before adopting a workflow that mixes generated and manual content.

---

Where Should I Configure the Generator?

Use .config/custy/config.toml. CLI flags are best for one-time overrides; project configuration is better for repeatable team behavior.