Lint this repo's Markdown in CI - #4
Merged
Merged
Conversation
ci.yml is a reusable workflow for the library repos and never runs here, so nothing has been checking the org-level docs. The frozen revs match Documentation's config so the two stay in step.
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
1 participant
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.
Nothing has ever linted this repo's Markdown.
ci.ymlisworkflow_call-only — a reusable workflow the library repos consume — so it never runs here, and the.markdownlint.jsonadded alongside MAINTAINERS.md had nothing invoking it.Adds a
.pre-commit-config.yamland alint.yamlthat runs it, mirroring Documentation's setup: the frozen hook revs are copied byte for byte from that repo so the two stay in step, and contributors get the same local hooks.One exclusion
PULL_REQUEST_TEMPLATE/pull_request_template.mdfailsMD041(no top-level heading). GitHub injects that file into the PR description, so it's a fragment rather than a document and starting it with an# H1would put a heading in every PR body. Excluded rather than "fixed".The exclusion is scoped to that path — a heading-less file anywhere else still fails, which I checked with a scratch file.
Verification
All hooks pass, and no existing file was modified — the org docs were already clean, so this is enforcement going forward rather than a cleanup.