-
Notifications
You must be signed in to change notification settings - Fork 49
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
Housekeeping: Markdownlint #905
Conversation
UI test coverage: 79.31% 🤷♂️ Did not change |
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.
This reads great, thank you for adding this useful tool to the CI workflow and updating the repo docs so quickly! ✨
docs/architecture-decision-records/20220121-conduit-plugin-architecture.md
Outdated
Show resolved
Hide resolved
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.
lovely work! and super useful :D
Description
Adds the CI action https://github.com/DavidAnson/markdownlint-cli2-action that executes https://github.com/DavidAnson/markdownlint when markdown files are updated. Settings are stored in
.markdownlint.yml
and taken mostly from here with some changes (i.e. line length 120, tables excluded from line length checks, hard tabs are allowed ingo
code blocks, Conduit needs to be written with an uppercase C).The CI action lints all markdown files (i.e. files that end with
.md
) exceptLICENSE.md
, anything inpkg/web/openapi
, anything inui/node_modules
and markdown files in.github
.I also ran
markdown-cli2-fix
that fixed most of the issues, the rest were fixed manually.Quick checks: