Skip to content

Markdownlint CI silently checks zero documentation files #260

Description

@dajiaohuang

Description

The repository's markdownlint configuration does not match the actual documentation layout, so the CI-equivalent command succeeds without checking any Markdown files.

.markdownlint-cli2.jsonc currently includes:

"01-tutorials/**/README.md",
"02-use-cases/**/README.md"

The tracked tutorials and use cases are under python/01-tutorials and python/02-use-cases.

Reproduction

Environment: Windows 11, Node.js v24.14.1, npm 11.11.0, commit 0890278a6571e4190c1ab8cacd9becc147f74d9c.

npx markdownlint-cli2@0.18.1

Result:

Linting: 0 file(s)
Summary: 0 error(s)

For comparison, an explicit repository-wide invocation scans all 750 tracked Markdown documents:

npx markdownlint-cli2@0.18.1 "**/*.md"

It reports 14,323 existing findings, confirming that the successful default run is caused by the empty glob rather than a clean documentation tree. The baseline ci-check run also reports markdownlint as passed.

Expected behavior

The configured CI command should select the intended tracked README/documentation files and should fail or report findings when those files violate the configured rules.

Impact

Required documentation structure and formatting checks can regress while CI remains green, including the repository's custom required-header rule.

Duplicate check

Open/closed issues, all PR states, commits, and file history were searched. PR #42 originally added markdownlint and PR #55 adjusted its exclusions, but neither addresses the current python/ path mismatch. No current equivalent issue or PR was found.

Why there is no PR in this audit

Simply prefixing the globs with python/ turns a zero-file check into a large failing migration with 14,323 existing findings. Maintainers need to choose the intended scope and rollout strategy (baseline/allowlist, staged cleanup, or narrower globs) before a small configuration patch can keep CI usable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions