EIPs icon indicating copy to clipboard operation
EIPs copied to clipboard

CI: Add Markdown Linter

Open Pandapip1 opened this issue 3 years ago • 48 comments

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

~~Should not be merged yet. Waiting on https://github.com/DavidAnson/markdownlint-cli2-action/issues/12 to be implemented.~~

Pandapip1 avatar Jul 28 '22 18:07 Pandapip1

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
  • Changes to EIP 1 require at least 5 unique approvals from editors; there's currently 1 approvals; the remaining editors are @axic, @samwilsn, @lightclient, @gcolvin

(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

eth-bot avatar Jul 28 '22 18:07 eth-bot

EIPW has over 18,000 lines of errors 😆

Pandapip1 avatar Jul 28 '22 18:07 Pandapip1

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.

Pandapip1 avatar Jul 28 '22 18:07 Pandapip1

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

github-actions[bot] avatar Jul 28 '22 18:07 github-actions[bot]

I broke eipw.

Pandapip1 avatar Jul 28 '22 18:07 Pandapip1

I broke eipw.

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

SamWilsn avatar Jul 28 '22 18:07 SamWilsn

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

Pandapip1 avatar Jul 28 '22 18:07 Pandapip1

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

github-actions[bot] avatar Jul 28 '22 19:07 github-actions[bot]

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

github-actions[bot] avatar Jul 28 '22 19:07 github-actions[bot]

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

SamWilsn avatar Jul 28 '22 20:07 SamWilsn

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

I'll split the PRs.

Pandapip1 avatar Jul 29 '22 01:07 Pandapip1

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

github-actions[bot] avatar Jul 29 '22 01:07 github-actions[bot]

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

github-actions[bot] avatar Jul 29 '22 01:07 github-actions[bot]

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.

MicahZoltu avatar Jul 29 '22 07:07 MicahZoltu

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

github-actions[bot] avatar Aug 01 '22 15:08 github-actions[bot]

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

github-actions[bot] avatar Aug 01 '22 15:08 github-actions[bot]

Testing new setup.

Pandapip1 avatar Aug 01 '22 15:08 Pandapip1

The commit 89c2c341c1743617fea2e2cff059858397f09374 (as a parent of 6f47ed2f6a687c12b2b7557167557f8619735315) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 01 '22 15:08 github-actions[bot]

The limiter works. Now it's time to make the config.

Pandapip1 avatar Aug 01 '22 15:08 Pandapip1

The commit 89c2c341c1743617fea2e2cff059858397f09374 (as a parent of 574fbeb6d951a19b96694833211cf064473af083) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 01 '22 15:08 github-actions[bot]

The commit c613eea4b23cf0cc3ed534a93d5c2bda76bfd286 (as a parent of 0b69a838ea9942f1b01ab2d9ac87d1b0f4935cce) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 01 '22 15:08 github-actions[bot]

The commit 8a536fc435e59d8cf496d2fff805cdaab46cc9ed (as a parent of 04ee02c80ad51ea87d7ec83a2f464184aa86a5a8) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 01 '22 16:08 github-actions[bot]

Unmarking as draft since this modifies EIP-1 and so won't automerge.

Pandapip1 avatar Aug 01 '22 16:08 Pandapip1

The commit 3c997ac4101bf5124921e678c2b7da51e4c6cfb4 (as a parent of a426188dca3555c9c555fdcda4ec28ef4793f6a3) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 01 '22 16:08 github-actions[bot]

@MicahZoltu @axic @lightclient @SamWilsn @gcolvin any objections to the settings I have set?

Pandapip1 avatar Aug 01 '22 17:08 Pandapip1

Didn't mean to close oops.

Pandapip1 avatar Aug 01 '22 17:08 Pandapip1

The commit 3c997ac4101bf5124921e678c2b7da51e4c6cfb4 (as a parent of 9a60886cb95452d26e078f6b1fde8048850ec8fa) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 01 '22 17:08 github-actions[bot]

The commit 3f02f1c14d36ad4b7c43c8ee70ee4fbf0d1181f1 (as a parent of 6386f0ad5a9bafcfb71a0ce490a442708dbd25e4) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 03 '22 00:08 github-actions[bot]

The commit 7256942980584e9ef0f3de591bc750b8a9b720b4 (as a parent of ff89b8f22eb9cec1da4430921316f5cd61973fa9) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 03 '22 00:08 github-actions[bot]

The commit 432b2c1edc4f472598012adc13431ea568859593 (as a parent of 595c373f4f243ede877cde93134ab60123e005d9) contains errors. Please inspect the Run Summary for details.

github-actions[bot] avatar Aug 03 '22 01:08 github-actions[bot]