Add linting for markdown files #4133
Merged
Conversation
This file contains 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
github-actions
bot
added
chore
Dependency Review✅ No vulnerabilities or license issues found.Scanned Manifest Files.github/workflows/lint.yml |
lucacome
force-pushed
the
chore/add-markdown-lint
branch
from
8097f59 to
c15fd26
Compare
Codecov Report
@@ Coverage Diff @@
## main #4133 +/- ##
==========================================
+ Coverage 51.84% 51.87% +0.02%
==========================================
Files 59 59
Lines 16710 16710
==========================================
+ Hits 8664 8668 +4
+ Misses 7747 7745 -2
+ Partials 299 297 -2 see 1 file with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
jjngx
approved these changes
Jul 21, 2023
jasonwilliams14
approved these changes
Jul 24, 2023
lucacome
force-pushed
the
chore/add-markdown-lint
branch
from
c15fd26 to
5944690
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed changes
Adds markdownlint step to pre-commit. All markdown files except the
.githubfiles (and docs for now) will be linted before every commit.Markdownlint will attempt to fix the linting errors and will report any errors it cannot fix.
Linting rules are in the
.markdownlint-cli2.yamlfile in the root of the repo.For details on the linting rules, see: DavidAnson/markdownlint@main/doc/Rules.md