Add header links in changelogs by Goooler · Pull Request #2241 · diffplug/spotless · GitHub
Skip to content

Add header links in changelogs#2241

Closed
Goooler wants to merge 1 commit into
mainfrom
g/add-header-links
Closed

Add header links in changelogs#2241
Goooler wants to merge 1 commit into
mainfrom
g/add-header-links

Conversation

@Goooler

@Goooler Goooler commented Aug 28, 2024

Copy link
Copy Markdown
Member

Follow up #2196.

image

@Goooler

Goooler commented Aug 28, 2024

Copy link
Copy Markdown
Member Author

@nedtwigg

Copy link
Copy Markdown
Member

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

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.

@Goooler

Goooler commented Aug 29, 2024

Copy link
Copy Markdown
Member Author

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.

@nedtwigg

Copy link
Copy Markdown
Member

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

@Goooler

Goooler commented Aug 30, 2024

Copy link
Copy Markdown
Member Author

@nedtwigg nedtwigg closed this Aug 30, 2024
@Goooler Goooler deleted the g/add-header-links branch August 30, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants