lighthouse icon indicating copy to clipboard operation
lighthouse copied to clipboard

Markdown linter

Open chong-he opened this issue 10 months ago • 5 comments

Issue Addressed

  • #5053

Additional Info

  • Added a script mdlint.sh in ./scripts folder. Only check the folder of ./book which is the Lighthouse book
  • Config file located in the same folder ./book named .markdownlint.yaml which the Markdown linter CLI automatically detects (Ref: https://github.com/igorshubovych/markdownlint-cli?tab=readme-ov-file#configuration)
  • Modify Makefile and test-suite.yml to add the Markdown linter

chong-he avatar Mar 27 '24 12:03 chong-he

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!

chong-he avatar Mar 28 '24 02:03 chong-he

can we run this conditionally, i.e. only for changes in markdown files?

jxs avatar Mar 29 '24 23:03 jxs

can we run this conditionally, i.e. only for changes in markdown files?

Yes, the VALIDATE_MARKDOWN: true is to only run this for markdown file. Got it from: https://github.com/super-linter/super-linter?tab=readme-ov-file#configure-super-linter which states:

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).

chong-he avatar Mar 31 '24 22:03 chong-he

Probably need to pass the actual linter first

AgeManning avatar Apr 03 '24 02:04 AgeManning

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 code-check later

chong-he avatar Apr 03 '24 02:04 chong-he

@mergifyio queue

michaelsproul avatar May 17 '24 06:05 michaelsproul

queue

🛑 The pull request has been removed from the queue default

The queue conditions cannot be satisfied due to failing checks.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI. Then, re-embark the pull request into the merge queue by posting the comment @mergifyio refresh on the pull request.

mergify[bot] avatar May 17 '24 06:05 mergify[bot]

@mergifyio requeue

michaelsproul avatar May 21 '24 01:05 michaelsproul

requeue

✅ This pull request will be re-embarked automatically

The followup queue command will be automatically executed to re-embark the pull request

mergify[bot] avatar May 21 '24 01:05 mergify[bot]

queue

🛑 The pull request has been removed from the queue default

The queue conditions cannot be satisfied due to failing checks.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI. Then, re-embark the pull request into the merge queue by posting the comment @mergifyio refresh on the pull request.

mergify[bot] avatar May 21 '24 01:05 mergify[bot]

@mergifyio requeue

michaelsproul avatar May 23 '24 00:05 michaelsproul

requeue

✅ This pull request will be re-embarked automatically

The followup queue command will be automatically executed to re-embark the pull request

mergify[bot] avatar May 23 '24 00:05 mergify[bot]

queue

🛑 The pull request has been removed from the queue default

The queue conditions cannot be satisfied due to failing checks.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI. Then, re-embark the pull request into the merge queue by posting the comment @mergifyio refresh on the pull request.

mergify[bot] avatar May 23 '24 00:05 mergify[bot]

Ah, looks like this is failing to merge because of some formatting issues in unstable. @chong-he can you back-merge unstable to this branch, and then get CI passing again? :pray:

https://github.com/sigp/lighthouse/actions/runs/9200347323/job/25306765265

michaelsproul avatar May 23 '24 01:05 michaelsproul

Ah, looks like this is failing to merge because of some formatting issues in unstable. @chong-he can you back-merge unstable to this branch, and then get CI passing again? 🙏

https://github.com/sigp/lighthouse/actions/runs/9200347323/job/25306765265

Done, thanks!

chong-he avatar May 23 '24 10:05 chong-he

@mergify queue

jimmygchen avatar May 23 '24 12:05 jimmygchen

queue

🛑 The pull request has been removed from the queue default

The pull request conflicts with at least one pull request ahead in queue.

You can take a look at Queue: Embarked in merge queue check runs for more details.

In case of a failure due to a flaky test, you should first retrigger the CI. Then, re-embark the pull request into the merge queue by posting the comment @mergifyio refresh on the pull request.

mergify[bot] avatar May 23 '24 12:05 mergify[bot]

@mergifyio requeue

michaelsproul avatar May 24 '24 00:05 michaelsproul

requeue

❌ This pull request head commit has not been previously disembarked from queue.

mergify[bot] avatar May 24 '24 00:05 mergify[bot]

@mergifyio queue

michaelsproul avatar May 24 '24 02:05 michaelsproul

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at 3070cb7c3982f8321bbeb33413009f8f928bdf8a

mergify[bot] avatar May 24 '24 02:05 mergify[bot]