googleapis / googleapis/release-please

Changelog.md - Follow Markdown liting

Open
#2,593 0 comments 9 reactions 1 assignee Claimed by @chingor13 View on GitHub
priority: p3 type: feature request
Dominant language
TypeScript
Stars
7.5k
Forks
588
Avg merge
12h 16m
Merged PRs (30d)
7

Description

Hi team 👋

I'd like to suggest an enhancement to the changelog generated by release-please-action. Currently, the output does not consistently follow Markdown linting best practices, which can lead to readability issues and problems with automated formatting tools.

Specifically, it would be great if the changelog adhered to the following markdownlint rules:

MD034/no-bare-urls: Avoid bare URLs; use Markdown links instead.
MD012/no-multiple-blanks: Prevent multiple consecutive blank lines.
MD024/no-duplicate-heading: Avoid duplicate headings at the same level.
MD032/blanks-around-lists: Ensure proper spacing around list items.

This would improve consistency and make the changelog easier to read and process in downstream tools.

Would you consider adding markdownlint compliance to the changelog generation logic or providing a configuration option for it?

Thanks for your work on this great tool!

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.