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

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #12731

Closed
wants to merge 8 commits into from

Conversation

yarikoptic
Copy link

More about codespell: https://github.com/codespell-project/codespell .

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

@CLAassistant
Copy link

CLAassistant commented Aug 8, 2024

CLA assistant check
All committers have signed the CLA.

@bep
Copy link
Member

bep commented Aug 9, 2024

Thanks for this. I will consider this if you provide a PR with only the GitHub action related files. As you may notice, there are build failures, but please don't try to fix those, just adjust the PR content.

@yarikoptic
Copy link
Author

I am sorry -- do you mean to not include typo fixes codespell did? should they go into a separate PR?
github action would not fix them, only alert about them.

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 2",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@yarikoptic
Copy link
Author

meanwhile I have signed SLA, rebased, redid codespell fixes with newer codespell (to address conflict + account new found on CI but not locally typo), and fixed indentation after codespell fix which lead to some linting CI jobs to fail.

@bep
Copy link
Member

bep commented Aug 9, 2024

You need to include the config setup ONLY. Don't run it.

@bep
Copy link
Member

bep commented Aug 9, 2024

I'm closing this for now. This may be interesting some time in the future, but as for now it creates too much noise.

@bep bep closed this Aug 9, 2024
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