ci(lint): ignore all generated CHANGELOGs in markdownlint - #662
Merged
Conversation
patextreme
force-pushed
the
ci/fix-markdownlint-changelog-ignore
branch
2 times, most recently
from
June 23, 2026 02:13
92a46d0 to
cce5a9b
Compare
patextreme
enabled auto-merge
June 23, 2026 02:16
yshyn-iohk
approved these changes
Jun 23, 2026
patextreme
disabled auto-merge
June 23, 2026 06:54
The File Hygiene workflow (reusable lint-files.yml from hyperledger-identus/.github) runs markdownlint-cli2 over **/*.md. The repo config (.markdownlint-cli2.yaml) ignored only the root CHANGELOG.md, but per-package CHANGELOGs (packages/**/CHANGELOG.md) are auto-generated by `nx release` and written without a trailing newline, violating MD047/single-trailing-newline. This made the lint / Markdown job fail on every PR after each release that rewrote the per-package changelogs (e.g. Dependabot PR #661). Fix: change the ignore from "CHANGELOG.md" to "**/CHANGELOG.md" so all generated changelogs (root + per-package) are exempt, consistent with how the root changelog was already handled. Verified locally: markdownlint-cli2 '**/*.md' -> 0 error(s). Signed-off-by: Pat Losoponkul <patextreme@hotmail.com>
patextreme
force-pushed
the
ci/fix-markdownlint-changelog-ignore
branch
from
June 23, 2026 08:13
cce5a9b to
d6948c6
Compare
patextreme
enabled auto-merge
June 23, 2026 08:13
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The File Hygiene workflow (
lint / Markdownjob) has been failing on every PR since the lastnx release, e.g. on Dependabot PR #661:All 7 failures are
MD047/single-trailing-newlineon per-package CHANGELOGs:Root cause
file-hygiene.ymlcalls the shared reusable workflowhyperledger-identus/.github/.github/workflows/lint-files.yml, which runsmarkdownlint-cli2-actionover**/*.md.The repo's
.markdownlint-cli2.yamlignored only the rootCHANGELOG.md:The per-package
packages/**/CHANGELOG.mdfiles are auto-generated bynx release(commitchore(release): [skip ci]) and are written without a trailing newline. Because they were not ignored, they were linted and failed MD047. After each release rewrites them, every subsequent PR fails the lint job.Fix
Change the ignore from
"CHANGELOG.md"to"**/CHANGELOG.md"so all generated changelogs (root + per-package) are exempt — consistent with how the root changelog was already handled. Generated content should not be hand-linted.Verification
markdownlint-cli2 '**/*.md'→Summary: 0 error(s)(44 files linted, down from 51; the 7 CHANGELOGs are now excluded).This is a permanent fix: future
nx releaseruns can regenerate the per-package CHANGELOGs without a trailing newline and the lint job will stay green.