Add codespell to CI to detect typos early

pydicom · Sep 18, 2021 · 59c23a2 · 59c23a2
1 parent b2c8ec6
commit 59c23a2
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 0 deletions.
diff --git a/.github/codespell_ignore_words.txt b/.github/codespell_ignore_words.txt
@@ -0,0 +1,4 @@
+ba
+complies
+ot
+siz
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -0,0 +1,17 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: codespell-project/actions-codespell@master
diff --git a/setup.cfg b/setup.cfg
@@ -3,3 +3,7 @@ test=pytest
 
 [bdist_wheel]
 universal=0
+
+[codespell]
+skip = _private_dict.py,_concepts_dict.py,test1.json
+ignore-words = .github/codespell_ignore_words.txt