Skip to content

CI: Add Markdown Linter#5367

Merged
SamWilsn merged 24 commits intoethereum:masterfrom
Pandapip1:lint-markdown
Oct 21, 2022
Merged

CI: Add Markdown Linter#5367
SamWilsn merged 24 commits intoethereum:masterfrom
Pandapip1:lint-markdown

Conversation

@Pandapip1
Copy link
Copy Markdown
Member

@Pandapip1 Pandapip1 commented Jul 28, 2022

Will require manual merging, due to modifying 432 files (432 > @eth-bot's limit of 100).

Should not be merged yet. Waiting on DavidAnson/markdownlint-cli2-action#12 to be implemented.

@eth-bot
Copy link
Copy Markdown
Collaborator

eth-bot commented Jul 28, 2022

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):


(fail) .github/workflows/ci.yml

classification
ambiguous
  • '.github/workflows/ci.yml' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

(fail) eip-1.md

classification
updateEIP

(fail) README.md

classification
ambiguous
  • 'README.md' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

(fail) config/.markdownlint.yaml

classification
ambiguous
  • 'config/.markdownlint.yaml' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

(fail) eip-template.md

classification
ambiguous
  • 'eip-template.md' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

(fail) last-call.xml

classification
ambiguous
  • 'last-call.xml' must be in eip-###.md format; this error will be overwritten upon relevant editor approval

@Pandapip1
Copy link
Copy Markdown
Member Author

Pandapip1 commented Jul 28, 2022

EIPW has over 18,000 lines of errors 😆

@Pandapip1
Copy link
Copy Markdown
Member Author

Oh yea, rationale. This quote describes it well:

Some constructs don't work well in all parsers and should be avoided. For example, here are some common/troublesome Markdown constructs.

I've noticed that such formatting errors sometimes happen. This will catch them.

@github-actions
Copy link
Copy Markdown

The commit 27ee9db (as a parent of 868d08a) contains errors. Please inspect the Run Summary for details.

@Pandapip1
Copy link
Copy Markdown
Member Author

I broke eipw.

@SamWilsn
Copy link
Copy Markdown
Contributor

I broke eipw.

Probably throttling to avoid the rate limiter. We're only allowed 1000 requests per hour.

@Pandapip1
Copy link
Copy Markdown
Member Author

Yea, the rate limit got 100% used up by codespell and the auto label bot.

@github-actions
Copy link
Copy Markdown

The commit ddf5b34 (as a parent of 57346db) contains errors. Please inspect the Run Summary for details.

@github-actions
Copy link
Copy Markdown

The commit b41b776 (as a parent of 99eeb5f) contains errors. Please inspect the Run Summary for details.

@SamWilsn
Copy link
Copy Markdown
Contributor

If there's any way to avoid changing old EIPs, I think we should do it.

@Pandapip1
Copy link
Copy Markdown
Member Author

If there's any way to avoid changing old EIPs, I think we should do it.

I'll split the PRs.

@github-actions
Copy link
Copy Markdown

The commit e19c5a7 (as a parent of 11a8be3) contains errors. Please inspect the Run Summary for details.

@github-actions
Copy link
Copy Markdown

The commit fb21558 (as a parent of efc29de) contains errors. Please inspect the Run Summary for details.

@MicahZoltu
Copy link
Copy Markdown

I would like to see the linting options limited to only things that are functional and avoid forcing a particular markdown style onto users. For example, MD034 - Bare URL used is useful because it results in the markdown file being more widely compatible with different rendering engines while MD029 - Ordered list item prefix is purely a stylistic choice and doesn't have an impact on final rendering.

If we do choose to integrate this, I wonder if we should move the heading checking that EIPW does to MD043 - Required heading structure?

I think we should include a configuration file, and fully populate it (don't rely on any defaults) so it is easy for us to discuss and modify individual rules.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 1, 2022

The commit e19c5a7 (as a parent of aa4cc6b) contains errors. Please inspect the Run Summary for details.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 1, 2022

The commit 8f2c35c (as a parent of 60bdf8f) contains errors. Please inspect the Run Summary for details.

Copy link
Copy Markdown
Contributor

@xinbenlv xinbenlv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the effort.

xinbenlv
xinbenlv previously approved these changes Sep 8, 2022
Copy link
Copy Markdown
Contributor

@xinbenlv xinbenlv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the effort.

SamWilsn
SamWilsn previously approved these changes Sep 19, 2022
lightclient
lightclient previously approved these changes Oct 3, 2022
Pandapip1 and others added 24 commits October 21, 2022 14:33
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: Micah Zoltu <micah@zoltu.net>
Co-authored-by: xinbenlv <zzn@zzn.im>
Co-authored-by: xinbenlv <zzn@zzn.im>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c-update Modifies an existing proposal e-number Waiting on EIP Number assignment s-draft This EIP is a Draft t-process

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants