Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: codespell: add spell checking CI job #146

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

hnez
Copy link
Member

@hnez hnez commented Jun 28, 2024

The codespell util allows catching typos with minimal false positives, because it uses a list of known common typos along with their correct spelling.

To limit the scope of this CI job to files we actually control, this excludes all external layers and all patch files via the .codespellrc.

@hnez hnez requested a review from SmithChart June 28, 2024 08:13
@hnez hnez force-pushed the codespell branch 3 times, most recently from 856cc27 to 043bdce Compare June 28, 2024 09:32
@ejoerns
Copy link
Collaborator

ejoerns commented Jun 28, 2024

Instead of providing a long exclude list, might it be easier to provide the paths to check (mainly meta-lxatac-* and the README.md) as an argument to the codespell call?

hnez added 2 commits July 1, 2024 08:19
Since `codespell` learns new typos all the time this job runs on a
schedule, in addition to pushes and pull requests.
This allows us fix new-found typos before they result in unrelated failed
CI runs in pull requests.

The scheduled time of 21:10 UTC on thursdays was chosen by fair dice roll.

Signed-off-by: Leonard Göhrs <l.goehrs@pengutronix.de>
Signed-off-by: Leonard Göhrs <l.goehrs@pengutronix.de>
@SmithChart
Copy link
Member

Instead of providing a long exclude list, might it be easier to provide the paths to check (mainly meta-lxatac-* and the README.md) as an argument to the codespell call?

Having an exclude list brings the advantage, that new code will be checked, even if the author does not know that it may needs to be added to a list.
The exclude list still fits on a single line on screen. I would be fine with that.

@hnez
Copy link
Member Author

hnez commented Jul 1, 2024

Hi,

Instead of providing a long exclude list, might it be easier to provide the paths to check (mainly meta-lxatac-* and the README.md) as an argument to the codespell call?

Having an exclude list brings the advantage, that new code will be checked, even if the author does not know that it may needs to be added to a list. The exclude list still fits on a single line on screen. I would be fine with that.

looks like we've look into this PR at this at the same time. While you wrote this comment I went ahead and updated the PR to use the explicit list suggested by @ejoerns.
Do you think we should keep it that way? I don't have a strong opinion either way.

@SmithChart
Copy link
Member

looks like we've look into this PR at this at the same time. While you wrote this comment I went ahead and updated the PR to use the explicit list suggested by @ejoerns. Do you think we should keep it that way? I don't have a strong opinion either way.

Well, bad timing. I don't have a strong opinion either. So let's stick to the explicit list.

@SmithChart SmithChart merged commit 8d9fde8 into linux-automation:scarthgap Jul 1, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants