spotless icon indicating copy to clipboard operation
spotless copied to clipboard

Add header links in changelogs

Open Goooler opened this issue 1 year ago • 2 comments

Follow up #2196.

image

Goooler avatar Aug 28 '24 14:08 Goooler

@nedtwigg I guess this should be covered from com.diffplug.spotless-changelog side. A bug or a new feature?

Goooler avatar Aug 28 '24 14:08 Goooler

What functionality do these Changelog things have that this URL does not?

  • https://github.com/diffplug/spotless/releases

My view is that CHANGELOG.md should be as simple as possible, and other tools like e.g. GitHub releases can make it "richer", but I don't think we need to pull that complexity into the changelog itself.

nedtwigg avatar Aug 28 '24 15:08 nedtwigg

These links point to the releases on GitHub Web, if we don't need them, should keep the formats like ## 3.0.0.BETA2 - 2024-08-25 instead of #[3.0.0.BETA2] - 2024-08-25.

Goooler avatar Aug 29 '24 00:08 Goooler

I'm following this convention: https://keepachangelog.com/en/1.1.0/

nedtwigg avatar Aug 29 '24 18:08 nedtwigg

Yeah, I noticed. But header links are used in this convention for displaying links in titles and keep the format concise, like this:

image

We don't have these links, therefore [] looks redundant. But anyway, such a small thing.

Goooler avatar Aug 30 '24 01:08 Goooler