Pending Commit

🚀Pending Commit

Active + Loaded Only

Include project-owned pending message content and review the current limits of generation and placement settings.

Command[tool.custy.changelog.pending_commit]

📦Category

Changelog Configuration

🚀Quick Command

[tool.custy.changelog.pending_commit]

---

commit-message.txtproviderloaded-only settings

---

📋

Properties

3

✅

Enabled

Active

🔄

Generation

Loaded only

📄

Placement

Loaded only

Properties

📋Properties

Property	Type	Description	Default	Required
enabled	Boolean	Active. Include the configured commit-message file through PendingCommitProvider for the newest unreleased range.	true	No
generation	append | regenerate	Loaded only. The active generator does not invoke the integrator that applies this mode.	regenerate	No
placement	before | after	Loaded only. The active generator does not currently reposition pending content.	before	No

Generated pending behavior

toml

[tool.custy.changelog.pending_commit]
enabled = true
generation = "regenerate"
placement = "before"

Generate from Git History Only

Use enabled to choose whether the configured commit-message file contributes additional content to the changelog:

Setting	Changelog message sources
enabled = true	Git commit history plus the pending message, when available, in the newest unreleased range.
enabled = false	Git commit history only; the pending message is not included as an additional source.

Edit the existing section in your project's .config/custy/config.toml rather than adding a second section with the same name:

Git history only

toml

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

You do not need to change generation or placement for this purpose. Then generate the changelog with the normal command:

Generate the changelog

bash

custy changelog generate

If the command skips generation under its normal rules, use custy changelog generate --force. This requests regeneration without overriding enabled = false or your other collection and rendering settings. To preview without writing CHANGELOG.md, use custy --dry-run changelog generate.

ℹ️Keep Your Commit Message File

Do not delete or empty .config/custy/templates/commit-message.txt just to exclude it from the changelog. Disabling pending integration does not change the file or prevent its use for a later commit. If the message was already committed, it can still appear through Git history, subject to your existing filters. This setting also applies when a release pipeline uses the same changelog generator; it does not disable that pipeline's commit step.

For the short answer, see the changelog generation FAQ.

💡The message path is configured elsewhere

Pending content reads tool.custy.cli.templates.file.commit_message. Keep the file path and pending behavior aligned.

⚠️Generation and placement do not currently alter output

The active generator can include pending content, but it does not invoke PendingCommitIntegrator. Treat generation and placement as loaded-only settings until that integration path becomes active.

Continue

🚀Related Commands

Commands commonly used together with this command.

Template Files

Configure commit_message.

Cleaning

Remove template-only content before rendering.

Commit Command

Manage the message's Git operation.