Repository and Compare Links

🚀Repository and Compare Links

Active

Build version comparison URLs beneath release headings.

Command[tool.custy.changelog.links]

📦Category

Changelog Configuration

🚀Quick Command

[tool.custy.changelog.links]

---

repository URLcomparereleases

---

📋

Properties

2

🛡️

Generated Default

Disabled

🌐

Host

Configurable

⚠️

Failure Mode

Warn and omit

Properties

📋Properties

Property	Type	Description	Default	Required
repository	HTTP(S) URL string	Project repository browser URL used only to construct changelog comparison links. This is not a Git remote name or push destination.	Empty	No
enable_compare	Boolean	Generate comparison URLs when repository contains a valid, non-placeholder browser URL.	false	No

Safe generated default

toml

[tool.custy.changelog.links]
repository = ""
enable_compare = false

To enable links, replace the empty value with the real project repository URL:

Enable comparison links

toml

[tool.custy.changelog.links]
repository = "https://github.com/your-org/your-project"
enable_compare = true

⚠️Placeholder and invalid URLs are not used

If comparison is enabled while repository is empty, still contains an example such as org/project, or is not a valid HTTP(S) browser URL, Custy logs a warning and continues generating the changelog without comparison links. The changelog command does not fail for this recoverable setting.

ℹ️Two switches affect visibility

enable_compare creates comparison URLs. render.show_compare_link decides whether the Jinja template displays available URLs.

Repository URL vs Git remotes

Setting	Value	Purpose
changelog.links.repository	Browser URL, such as https://github.com/org/project	Build links in CHANGELOG.md
git.default_remote	One remote name, such as origin	Provide a fallback for operations that use one remote
git.main_remotes / git.backup_remotes	Lists of remote names	Group authoritative and mirror destinations

Use git remote -v to discover remote names and URLs. Do not copy a remote name such as origin into changelog.links.repository.

Continue

🚀Related Commands

Commands commonly used together with this command.

Rendering

Configure show_compare_link.

Releases

Control visible versions.

Git Remotes

Configure operational remotes separately from documentation links.