-
Notifications
You must be signed in to change notification settings - Fork 742
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
Markdown linter #5494
Markdown linter #5494
Conversation
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.
Nice!
Could we add it into the code-check
test?
I recall grouping things improved the speed of CI and it seems this could fit under that test?
I will look into it, thanks! |
can we run this conditionally, i.e. only for changes in markdown files? |
Yes, the If you set any of the VALIDATE_[LANGUAGE] variables to true, super-linter defaults to leaving any unset variable to false (only validate those languages). |
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.
Purely formating changes, nothing controversial. They look good! I welcome the linter
Probably need to pass the actual linter first |
Yes I am still figuring out to make it pass the CI. I will also make the linter to be in the same check with |
book/src/validator-inclusion.md
Outdated
@@ -30,17 +30,17 @@ is not the case for attestations from the _previous_ epoch. | |||
|
|||
``` |
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.
try adding text
here
✅ This pull request will be re-embarked automaticallyThe followup |
🛑 The pull request has been removed from the queue
|
@Mergifyio requeue |
✅ This pull request will be re-embarked automaticallyThe followup |
🛑 The pull request has been removed from the queue
|
Ah, looks like this is failing to merge because of some formatting issues in https://github.com/sigp/lighthouse/actions/runs/9200347323/job/25306765265 |
Merge unstable to markdown branch
Done, thanks! |
@mergify queue |
🛑 The pull request has been removed from the queue
|
@Mergifyio requeue |
❌ This pull request head commit has not been previously disembarked from queue. |
@Mergifyio queue |
✅ The pull request has been merged automaticallyThe pull request has been merged automatically at 3070cb7 |
Issue Addressed
Additional Info
mdlint.sh
in./scripts
folder. Only check the folder of./book
which is the Lighthouse book./book
named.markdownlint.yaml
which the Markdown linter CLI automatically detects (Ref: https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration)Makefile
andtest-suite.yml
to add the Markdown linter