Skip to content

fix(markdown-lint): exclude CHANGELOG.md from lint globs#240

Merged
JacobPEvans merged 1 commit intomainfrom
fix/changelog-lint-exclude
Apr 26, 2026
Merged

fix(markdown-lint): exclude CHANGELOG.md from lint globs#240
JacobPEvans merged 1 commit intomainfrom
fix/changelog-lint-exclude

Conversation

@JacobPEvans
Copy link
Copy Markdown
Owner

Summary

  • Adds !CHANGELOG.md to the markdownlint glob patterns in _markdown-lint.yml

Why

release-please generates CHANGELOG.md with long GitHub PR URLs (MD013 violations) and double blank lines between section headers (MD012 violations). This is by design and won't be fixed upstream (googleapis/release-please#2085, closed won't-fix).

ignorePatterns in the config and per-file overrides are not respected when the action passes explicit globs — a negative glob entry is the only reliable exclusion mechanism.

Test Plan

🤖 Generated with Claude Code

release-please generates CHANGELOG.md with long GitHub PR URLs
that exceed MD013 limits, and double blank lines between sections
that trigger MD012. Both are structural artifacts of release-please
format (googleapis/release-please#2085, closed won't-fix).

ignorePatterns and per-file overrides in config are not applied when
the action passes explicit globs — the only reliable mechanism is a
negative glob entry.

(claude)
Copilot AI review requested due to automatic review settings April 26, 2026 22:30
@gemini-code-assist
Copy link
Copy Markdown

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the reusable markdownlint workflow to reliably exclude CHANGELOG.md from linting, preventing known release-please-generated formatting from failing markdownlint checks.

Changes:

  • Add a negative glob (!CHANGELOG.md) to the markdownlint-cli2-action globs input to exclude the generated changelog file.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@JacobPEvans JacobPEvans merged commit 07d5dfb into main Apr 26, 2026
6 checks passed
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