automatic spellcheck by codespell for common misspellings.

Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>

Author: fujitatomoya

.github/workflows/test.yml

@@ -37,6 +37,23 @@ jobs:
       - name: Lint
         run: make lint
 
+  spellcheck:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies with pip
+        run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt
+
+      - name: Spellcheck
+        run: make spellcheck
+
   build:
     needs: [test, lint]
     runs-on: ubuntu-22.04

Makefile

@@ -28,6 +28,9 @@ lint:
 test:
 	doc8 --ignore D001 --ignore-path build
 
+spellcheck:
+	git ls-files '*.md' '*.rst' | xargs codespell --ignore-words=codespell_whitelist.txt --skip="source/Releases/*"
+
 linkcheck:
 	$(BUILD) -b linkcheck $(OPTS) $(SOURCE) $(LINKCHECKDIR)
 	@echo

README.md

@@ -51,6 +51,15 @@ For local testing of the current tree use:
 
 `sensible-browser build/html/index.html`
 
+### Spelling Check
+
+To check the spelling, use:
+
+`make spellcheck`
+
+> [!NOTE]
+> If that detects specific words that need to be ignored, add it to [codespell_whitelist](./codespell_whitelist.txt).
+
 ### Deployment test
 
 To test building the multisite version deployed to the website use:

codespell_whitelist.txt

@@ -0,0 +1,2 @@
+empy
+indention

requirements.txt

@@ -1,3 +1,4 @@
+codespell
 doc8
 docutils
 pip