Markdown linter by chong-he · Pull Request #5494 · sigp/lighthouse

chong-he · 2024-03-27T12:54:50Z

Issue Addressed

Lint book markdown #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

AgeManning

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?

chong-he · 2024-03-28T02:15:17Z

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!

.github/workflows/test-suite.yml

jxs · 2024-03-29T23:35:15Z

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

chong-he · 2024-03-31T22:58:15Z

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

dapplion

Purely formating changes, nothing controversial. They look good! I welcome the linter

AgeManning · 2024-04-03T02:22:32Z

Probably need to pass the actual linter first

chong-he · 2024-04-03T02:51:12Z

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

michaelsproul · 2024-04-04T04:13:03Z

book/src/validator-inclusion.md

@@ -30,17 +30,17 @@ is not the case for attestations from the _previous_ epoch.

 ```


try adding text here

mergify · 2024-05-21T01:13:13Z

requeue

✅ This pull request will be re-embarked automatically

Details

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

mergify · 2024-05-21T01:13:14Z

queue

🛑 The pull request has been removed from the queue `default`

Details

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.

michaelsproul · 2024-05-23T00:37:05Z

@Mergifyio requeue

mergify · 2024-05-23T00:37:08Z

requeue

✅ This pull request will be re-embarked automatically

Details

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

mergify · 2024-05-23T00:37:09Z

queue

🛑 The pull request has been removed from the queue `default`

Details

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.

michaelsproul · 2024-05-23T01:14:27Z

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

Merge unstable to markdown branch

chong-he · 2024-05-23T10:08:44Z

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!

jimmygchen · 2024-05-23T12:12:45Z

@mergify queue

mergify · 2024-05-23T12:12:53Z

queue

🛑 The pull request has been removed from the queue `default`

Details

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.

michaelsproul · 2024-05-24T00:54:43Z

@Mergifyio requeue

mergify · 2024-05-24T00:54:54Z

requeue

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

michaelsproul · 2024-05-24T02:43:32Z

@Mergifyio queue

mergify · 2024-05-24T02:43:38Z

queue

✅ The pull request has been merged automatically

Details

The pull request has been merged automatically at 3070cb7

chong-he added 2 commits March 26, 2024 20:52

linter

d7507d3

Add markdown linter

91f45b4

chong-he added the work-in-progress PR is a work-in-progress label Mar 27, 2024

chong-he added 3 commits March 27, 2024 21:07

add env

4d7e924

only check markdown

db48440

Add token

8b81717

AgeManning reviewed Mar 28, 2024

View reviewed changes

michaelsproul reviewed Mar 28, 2024

View reviewed changes

.github/workflows/test-suite.yml Outdated Show resolved Hide resolved

Update .github/workflows/test-suite.yml

3a84d93

michaelsproul added the infra-ci label Mar 28, 2024

chong-he added 6 commits April 2, 2024 08:15

Markdown linter

92aadd7

Exit code

d74afc8

Update script

09849e1

rename

d9df229

mdlint

e1b4476

Add an empty line after end of file

8001e04

dapplion approved these changes Apr 2, 2024

View reviewed changes

dapplion self-requested a review April 3, 2024 02:53

Testing disable

d8a77bd

michaelsproul reviewed Apr 4, 2024

View reviewed changes

chong-he added 5 commits April 10, 2024 09:32

add text

289d42d

update mdlint.sh

1f4d897

ori validator inclusion

27f3477

Add config yml file

ba9e563

Remove MD041 and fix advanced-datadir file

bb756e3

mergify bot added a commit that referenced this pull request May 21, 2024

Merge of #5494

d3285a3

mergify bot mentioned this pull request May 21, 2024

merge queue: embarking unstable (2a87016) and #5494 together #5818

Closed

5 tasks

jimmygchen added ready-for-merge This PR is ready to merge. and removed ready-for-review The code is ready for review labels May 21, 2024

mergify bot added a commit that referenced this pull request May 23, 2024

Merge of #5494

752acec

mergify bot mentioned this pull request May 23, 2024

merge queue: embarking unstable (8762d82) and #5494 together #5827

Closed

5 tasks

michaelsproul added waiting-on-author The reviewer has suggested changes and awaits thier implementation. and removed ready-for-merge This PR is ready to merge. labels May 23, 2024

chong-he and others added 2 commits May 23, 2024 10:26

Merge pull request #7 from chong-he/unstable

3daf15e

Merge unstable to markdown branch

mdlint

3f8f28a

chong-he added ready-for-merge This PR is ready to merge. and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. labels May 23, 2024

chong-he and others added 2 commits May 24, 2024 07:17

Merge branch 'unstable' into markdown-linter

b7a1722

mdlint

b776383

mergify bot merged commit 3070cb7 into sigp:unstable May 24, 2024

chong-he mentioned this pull request May 25, 2024

Lint book markdown #5053

Closed

chong-he deleted the markdown-linter branch June 16, 2024 13:53

		@@ -30,17 +30,17 @@ is not the case for attestations from the _previous_ epoch.

		```

Conversation

chong-he commented Mar 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue Addressed

Additional Info

Uh oh!

AgeManning left a comment

Choose a reason for hiding this comment

Uh oh!

chong-he commented Mar 28, 2024

Uh oh!

Uh oh!

jxs commented Mar 29, 2024

Uh oh!

chong-he commented Mar 31, 2024

Uh oh!

dapplion left a comment

Choose a reason for hiding this comment

Uh oh!

AgeManning commented Apr 3, 2024

Uh oh!

chong-he commented Apr 3, 2024

Uh oh!

michaelsproul Apr 4, 2024

Choose a reason for hiding this comment

Uh oh!

mergify bot commented May 21, 2024

✅ This pull request will be re-embarked automatically

Uh oh!

mergify bot commented May 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛑 The pull request has been removed from the queue default

Uh oh!

michaelsproul commented May 23, 2024

Uh oh!

mergify bot commented May 23, 2024

✅ This pull request will be re-embarked automatically

Uh oh!

mergify bot commented May 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛑 The pull request has been removed from the queue default

Uh oh!

michaelsproul commented May 23, 2024

Uh oh!

chong-he commented May 23, 2024

Uh oh!

jimmygchen commented May 23, 2024

Uh oh!

mergify bot commented May 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛑 The pull request has been removed from the queue default

Uh oh!

michaelsproul commented May 24, 2024

Uh oh!

mergify bot commented May 24, 2024

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

Uh oh!

michaelsproul commented May 24, 2024

Uh oh!

mergify bot commented May 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ The pull request has been merged automatically

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

chong-he commented Mar 27, 2024 •

edited

Loading

mergify bot commented May 21, 2024 •

edited

Loading

🛑 The pull request has been removed from the queue `default`

mergify bot commented May 23, 2024 •

edited

Loading

🛑 The pull request has been removed from the queue `default`

mergify bot commented May 23, 2024 •

edited

Loading

🛑 The pull request has been removed from the queue `default`

mergify bot commented May 24, 2024 •

edited

Loading