Skip to content

Commit

Permalink
Use ignore words file with codespell
Browse files Browse the repository at this point in the history
It is not possible to automatically backport pull requests that makes
modifications to workflow files and since the codespell action has a
hard-coded list of ignored words as options, this means that any
changes to the ignored codespell words cannot be backported.

This pull request fixes this by using a ignore words file instead,
which means that adding new words does not require changing a workflow
file and hence the pull requests can be automatically backported.
  • Loading branch information
mkindahl committed Apr 11, 2024
1 parent 8347621 commit cb01cfc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .github/ignore-words
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
brin
inh
larg
inout
2 changes: 1 addition & 1 deletion .github/workflows/code_style.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ jobs:
- name: Run codespell
run: |
find . -type f \( -name "*.c" -or -name "*.h" -or -name "*.yaml" -or -name "*.sh" \) \
-exec codespell -L "brin,inh,larg,inout" {} \+
-exec codespell -I .github/ignore-words {} \+
cc_checks:
name: Check code formatting
Expand Down

0 comments on commit cb01cfc

Please sign in to comment.