CI: Add automatic PR review for misspellings

[zbeekman]

Add bot to post comments/reviews on PRs for misspelling issues using reviewdog/action-misspell

A new token may need to be created to allow comments to be posted on PRs instead of just PR status. This would have caught typos in my previous PRs. Token info is here: https://github.com/reviewdog/reviewdog#reporter-github-pullrequest-review-comment--reportergithub-pr-review

[certik]

This is what I see in the test:

Does that mean it passed it? How does it look like when it fails?

Can you please rebase on top of the latest master, so that we can merge it?

[zbeekman]

@certik: With the token setup correctly, it will comment in the PR if it detects misspellings in changed files:

No need to check the CI output by hand. We may need to create a new token and set it in the repo's secrets. I will rebase this onto master soon, but I need to run out for a moment right now.

[certik]

Do you know how often this has false positives? Say reporting some correctly spelled Fortran variable names as misspelled?

…

On Tue, Dec 31, 2019, at 9:09 AM, zbeekman wrote: @certik <https://github.com/certik>: With the token setup correctly, it will comment in the PR if it detects misspellings in changed files: rd-image <https://user-images.githubusercontent.com/3797062/64926127-b8b0bc00-d834-11e9-97d5-5b6aa06dc573.png> No need to check the CI output by hand. We may need to create a new token and set it in the repo's secrets. I will rebase this onto master soon, but I need to run out for a moment right now. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#56?email_source=notifications&email_token=AAAFAWEPGT7XHFBOUYHRHALQ3NVD3A5CNFSM4KBSAVX2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEH4ML5I#issuecomment-569951733>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAFAWHZR4ILFMPJAOKQYRDQ3NVD3ANCNFSM4KBSAVXQ>.

[zbeekman]

Do you know how often this has false positives? Say reporting some correctly spelled Fortran variable names as misspelled?

In my experience this almost never happens. It doesn't change the PR status just posts comments on the code, so false positives can be easily ignored. If it becomes an issue we can always remove it.

[certik]

@zbeekman you should have push access and other rights to the repository. Go ahead and set this up if you have time.

Let's try it, and if it works, great. If it doesn't work for us, we can remove it later.

[certik]

Looks good to me. I'll leave it to you @zbeekman to merge and to set this up if some token has to be setup.

[zbeekman]

Looks good to me. I'll leave it to you @zbeekman to merge and to set this up if some token has to be setup.

Great, and if it ever has too many false-positives, etc. we should disable it or tweak the scope.

One small issue regarding tokens: I'm happy to provide a personal access token with the correct scopes, however to add the secret to the repository someone with greater privileges (admin I think) will need to do so.

[certik]

Send me the token by email and I'll put it there.