Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generated markdown is invalid according to markdownlint #190

Closed
brodock opened this issue Aug 17, 2023 · 1 comment
Closed

Generated markdown is invalid according to markdownlint #190

brodock opened this issue Aug 17, 2023 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@brodock
Copy link

brodock commented Aug 17, 2023

Describe the bug
Running the patchChangelog, removes the empty line between the Level 2 and Level 3 Headers and any list item present there, which is considered invalid by markdownlint.

To Reproduce

  1. Include items in the unreleased section.
  2. Run patchChangelog task
  3. Run markdownlint against CHANGELOG.md

This is an example of the violations:

CHANGELOG.md:15 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Changed"]
CHANGELOG.md:16 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Some content you added to the Unreleased section"]

Expected behavior
The generated Markdown should include an empty line after the Level 3 headers. This is enough to comply with both violations.

Environment:

  • OS: macOS Ventura 13.5
  • Gradle Changelog Plugin Version: 2.1.2
  • Gradle Version: 8.2.1

Additional context
Add any other context about the problem here.

@brodock brodock added the bug Something isn't working label Aug 17, 2023
@hsz hsz added this to the next milestone Aug 28, 2023
@hsz
Copy link
Member

hsz commented Aug 28, 2023

Thanks for reporting, Gabriel!
Since the next release, headings and lists will be surrounded with blank lines.

@hsz hsz closed this as completed Aug 28, 2023
@hsz hsz added enhancement New feature or request and removed bug Something isn't working labels Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants