-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add markdown linter #3673
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
Add markdown linter #3673
Conversation
martincostello
commented
Nov 23, 2025
- Add markdownlint.
- Update actionlint to the latest version.
- Update zizmor to the latest version.
- Add markdownlint. - Update actionlint to the latest version. - Update zizmor to the latest version.
Rename `actions-lint` to `lint`.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3673 +/- ##
=======================================
Coverage 94.53% 94.53%
=======================================
Files 111 111
Lines 3861 3861
Branches 778 778
=======================================
Hits 3650 3650
Misses 211 211
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Fix various markdownlint warnings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds markdown linting to the project's CI workflow and updates existing linters to their latest versions. The changes include renaming the workflow file from actions-lint.yml to lint.yml and applying markdown formatting fixes throughout the documentation to comply with the new linter rules.
- Added markdownlint-cli2 for markdown file linting with configuration in
.markdownlint.json - Updated actionlint from v1.7.7 to v1.7.9 and zizmor from v1.14.1 to v1.16.3
- Applied markdown formatting fixes including proper heading syntax, table alignment, and blank lines
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/lint.yml |
Renamed from actions-lint.yml, updated linter versions, and added markdownlint step |
.github/zizmor.yml |
Added configuration to disable new zizmor rules (concurrency-limits and dependabot-cooldown) |
Swashbuckle.AspNetCore.slnx |
Updated workflow file reference from actions-lint.yml to lint.yml |
README.md |
Added "Getting Started" heading and fixed table column alignment syntax |
CONTRIBUTING.md |
Fixed heading syntax from underlined style to ATX style (using # symbols) |
docs/migrating-to-v10.md |
Added blank line after code block for proper markdown formatting |
Comments suppressed due to low confidence (1)
.github/workflows/lint.yml:9
- The
paths-ignoreconfiguration excludes**/*.mdfiles, which means the workflow will not run when markdown files are modified in push events. This conflicts with the newly added markdown linting step (lines 53-58) that specifically checks markdown files.
Consider removing - '**/*.md' from the paths-ignore list so that markdown changes trigger the linter, or explicitly add paths for markdown files in the pull_request trigger to ensure markdown files are linted in PRs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.