Skip to content

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

Closed
yarikoptic wants to merge 7 commits into
argoproj:masterfrom
yarikoptic:enh-codespell
Closed

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#3584
yarikoptic wants to merge 7 commits into
argoproj:masterfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

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.

This PR was partially inspired by the their viral propagation in generated or output code and manifesting there in

Potential TODOs:

  • add codespell target to some other target (lint?) of Makefile?
  • pin version of codespell in github actions? apparently here seems pining is not dominating?

yarikoptic added 7 commits May 8, 2025 10:35
Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
that would avoid triggering "codespell"

Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
…(but ignoring overall fail due to ambigous ones)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w || :",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
…os automagically

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

Signed-off-by: Yaroslav O. Halchenko <debian@onerussian.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 8, 2025

This Pull Request is stale because it has been open for 60 days with
no activity. It will be closed in 7 days if no further activity.

@github-actions github-actions Bot added the stale label Jul 8, 2025
@github-actions github-actions Bot closed this Jul 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant