Add codespell to CI to catch typos early

[DimitriPapadopoulos]

Description

Run codespell in CI to catch typos early on.

Use GitHub Actiosn with actions-codespell.

Related PR: #185

Checklist

• [ ] I have commented my code, particularly in hard-to-understand areas
• [ ] My changes generate no new warnings
• [ ] My code follows the style guidelines of this project

[vsoch]

Good idea! Please use an exact sha instead of a branch or tag so it's not a moving target.

[DimitriPapadopoulos]

For what it's worth, it's supposed to be used like this:

uses: codespell-project/actions-codespell@master

See https://github.com/codespell-project/actions-codespell#usage

[DimitriPapadopoulos]

But I agree there is a risk.

[vsoch]

Yes I'm aware how GitHub actions work - for actions that I don't control my preference is to use a non moving target. A commit sha, and not a branch or release tag.

[DimitriPapadopoulos]

OK, I have used the current commit.

[vsoch]

Perfect! I think you just need to provide the entire sha and it will work.

[vsoch]

Thanks! This will prevent my future misspellings :)

[DimitriPapadopoulos]

In the future, false positives can be added to .github/codespell_ignore_words.txt. Hopefully there won't be many.