-
Notifications
You must be signed in to change notification settings - Fork 53
ci: enforce MD040 on markdown with markdownlint-cli2 #870
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: Markdown | ||
|
|
||
| on: | ||
| push: | ||
| paths: | ||
| - "**/*.md" | ||
| - ".markdownlint-cli2.jsonc" | ||
| - ".github/workflows/markdown.yml" | ||
| pull_request: | ||
| paths: | ||
| - "**/*.md" | ||
| - ".markdownlint-cli2.jsonc" | ||
| - ".github/workflows/markdown.yml" | ||
|
|
||
| # Linting documentation needs nothing but the checkout, so the job's | ||
| # GITHUB_TOKEN is narrowed to read-only rather than inheriting whatever the | ||
| # repository default grants. | ||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| markdownlint: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6.1.0 | ||
| # markdownlint-cli2 is pinned to the version the review tooling reports, | ||
| # so a finding raised in review reproduces locally with the same command | ||
| # and the same result. Globs and ignores come from | ||
| # .markdownlint-cli2.jsonc, so this bare invocation matches CI exactly. | ||
| - name: markdownlint-cli2 | ||
| run: npx --yes markdownlint-cli2@0.23.2 | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| // Markdown lint configuration for the repository's documentation. | ||
| // | ||
| // The ruleset is deliberately narrow: it starts from `default: false` and | ||
| // enables only what AGENTS.md § Documentation Guidelines actually mandates, | ||
| // so the job fails on policy violations and stays silent about style the | ||
| // repository has never agreed on. | ||
| // | ||
| // Turning on markdownlint's full default set today would report ~1560 | ||
| // findings across 38 files (768 of them MD013 line-length alone), which is a | ||
| // reformatting project, not a lint gate. Rules can be promoted here one at a | ||
| // time as the tree is cleaned up — each promotion should land together with | ||
| // the fixes that make it green. | ||
| "config": { | ||
| "default": false, | ||
| // AGENTS.md: "Add a language specifier to every fenced code block." | ||
| "MD040": true | ||
| }, | ||
| "globs": ["**/*.md"], | ||
| "ignores": ["target/**", "node_modules/**", ".git/**"] | ||
| } |
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
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.