website icon indicating copy to clipboard operation
website copied to clipboard

Spelling errors are unclear in pull request CI results and spell checker is unmaintained

Open wallrj opened this issue 3 years ago • 1 comments

When the spell-checker is run from CI for a PR and fails, the results are not syntax highlighted so it's difficult to know which word caused the failure. For example:

image

https://prow.build-infra.jetstack.net/view/gs/jetstack-logs/pr-logs/pull/cert-manager_website/797/pull-cert-manager-website-verify/1483400121444995072

We use https://github.com/lukeapage/node-markdown-spellcheck which seems to be unmaintained. Its dependencies are out-of-data and causing false-alarms from Dependabot

image https://github.com/cert-manager/website/security/dependabot/package-lock.json/marked/open

Perhaps we should use a different spell checker. For example:

  • https://github.com/kubernetes/website/pull/26228
  • https://github.com/cncf/glossary/pull/111
  • https://megalinter.github.io/latest/descriptors/spell/

/bug

wallrj avatar Jan 21 '22 13:01 wallrj

Well, you could use https://github.com/marketplace/actions/check-spelling 😺

jsoref avatar Jan 26 '22 15:01 jsoref