Add a GitHub Action for codespell

[peternewman]

Using this seems easiest:
https://github.com/actions/toolkit/blob/master/docs/problem-matchers.md

This looks like quite a good example to base it on:
https://github.com/TrueBrain/actions-flake8

There are a couple of Codespell actions already:
https://github.com/marketplace?type=actions&query=codespell

Both by @plettich .

One just uses the dictionary, and so presumably would need an update for out multi-dictionary, won't have the same options etc (as well as only creating review comments):
https://github.com/marketplace/actions/codespell-action

The other one uses Review Dog, which seems like an unnecessary overhead now the problem matchers exist:
https://github.com/marketplace/actions/run-codespell-with-reviewdog

[peternewman]

For just how awesome this is, see here:
https://github.com/codespell-project/codespell/pull/1502/files

[larsoner]

Seems useful to me

[peternewman]

First draft:
https://github.com/peternewman/actions-codespell/actions/runs/102795540

We'll need to move this into the project at some point too. I'm sure it needs a bit of tidying up...

[peternewman]

It's also currently catching the line buffering error from #1331 .

[plettich]

Hi,
the actions in the marketplace were a first attempt from me on GitHub Actions. We use the ReviewDog variant in our project. I would be happy to turn the development over to a more appropriate organization :-)

[peternewman]

Heh thanks @plettich . Have you got a ReviewDog one you could link to?

Or alternatively here's the first draft of annotations, which I assume is probably better:
https://github.com/peternewman/actions-codespell/pull/1/files

I can't take any credit though, I've just taken @TrueBrain 's hard work and changed a few trivial bits!

[plettich]

The code can be found here: https://github.com/plettich/action-codespell
It looks like this: https://github.com/plettich/privacyidea/pull/17/files

[peternewman]

It looks like this: https://github.com/plettich/privacyidea/pull/17/files

Thanks @plettich . Looks like ReviewDog only adds a little bit of noise, but I suspect doing it directly would be easiest.

[peternewman]

We should also get this repo moved to the codespell-project org at some point @larsoner . I think I just temporarily need the right to create repositories in the org to be able to migrate it.

[cclauss]

okken/cards#43 —> https://youtu.be/2OD8E9ziSYQ

[peternewman]

okken/cards#43 —> https://youtu.be/2OD8E9ziSYQ

That's neat @cclauss .

Personally I think the annotation is the real winner here, although I think we could also ship an action which just adds the matchers (and use that in our full action), so you'd then get the best of both worlds.

[plettich]

It looks like this: https://github.com/plettich/privacyidea/pull/17/files

Thanks @plettich . Looks like ReviewDog only adds a little bit of noise, but I suspect doing it directly would be easiest.

actually it also limits the output only to the code touched in the PR, which can be nice if You have a large Project and don't want to struggle with excluding files and samples.

[peternewman]

I would be happy to turn the development over to a more appropriate organization :-)

@plettich now our action is released and in use by people, do you fancy signposting it from your action?

It might also avoid you needing to deal with issues like this 😉 :
plettich/python_codespell_action#7

[skangas]

Could this issue be closed?

[cclauss]

Yes. https://github.com/codespell-project/actions-codespell