ci: add mdformat check; fix README table alignment#98
Merged
Conversation
Add a PR workflow that runs `mdformat --check .` against .mdformat.toml so malformed Markdown can no longer reach the default branch. Also re-format the README RFP table, whose column alignment had drifted. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Install mdformat-gfm and mdformat-frontmatter so CI uses the same formatter the README documents. Bare mdformat lacks GFM table support and mangles every table-containing file, so the check could never pass. Also drop the pull_request paths filter; this is a Markdown repo, so run the check on every PR. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Clears the Node 20 deprecation warning; both v6 majors run on Node 24. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
.github/workflows/mdformat.yml— a CI workflow that runsmdformat --check .on every PR and on pushes tomaster, using the repo's.mdformat.toml(number = true,wrap = 80).closedcells and a crampedClosed|cell).Why
There was no CI guard on Markdown formatting, so malformed Markdown could reach the default branch — which is exactly how the README table misalignment landed. This adds the gate and fixes the existing breakage so the branch is green.
Notes
mdformat mdformat-gfm mdformat-frontmatter— the same toolchain the README documents. The GFM plugin is required for table support; baremdformatlacks it and mangles every table-containing file.pathsfilter) since this is a Markdown repo, plus pushes tomaster.actions/checkout@v6andactions/setup-python@v6(Node 24).mdformat .locally to auto-fix any future failures.🤖 Generated with Claude Code