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: add codespell check script for tracking typos #12232
Conversation
1036ce6
to
28a36ad
Compare
28a36ad
to
c8ea9aa
Compare
0335f3c
to
700a009
Compare
There's a lot of force-pushing going on here. ;) |
Yeah, I wanted to verify if the container was running the right version. Now everything seems ok. When the Murdock workers are updated, this will be ready for merge (after reviews of course). |
7453aae
to
3f1d292
Compare
Ah, this was the other PR waiting on CI update ;) |
Now it works also on Murdock! |
I tried this on master, there are ~1000 hits, most of them typos but some false positives ("od" -> "of", "WAN" -> "WANT"). Can we change the return value in case of errors to "0", so it basically becomes a warning? With that I'd be OK to merge. Then I think we need an "--exclude-file" so we can filter the false positives, fix all actual typos and then make this use live ammunition (exit 1 on typo). (but in follow-up PRs). |
We can add them to a list of excluded patterns (see here).
OK
If you call the script directly, all files are parsed but using |
Well, we'd need a file for that, too, then (list will get long fast). But wouldn't doing that reduce effectiveness? While some cases might want to use "od" instead of "of", that might also be a real typo. Using "--exclude-file", we have to explicitly add every false-positive line, but codespell stays sharp. |
Yes, and it shows typos that were already in a file, when doing a probably unrelated change... |
You can squash directly! |
3f1d292
to
3e37681
Compare
squashed |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ACK.
Thank you! |
Contribution description
This PR introduce a new static check script for tracking typos in PRs.
Testing procedure
Issues/PRs references
Should help with #12230