Include spell checker in github ci/cd

.cspell/cspell.config.yaml

@@ -0,0 +1,11 @@
+---
+$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
+version: '0.2'
+dictionaryDefinitions:
+  - name: custom-dictionary
+    path: './custom-dictionary.txt'
+    addWords: true
+dictionaries:
+  - custom-dictionary
+ignorePaths:
+  - 'paper/paper.bib'

.cspell/custom-dictionary.txt

@@ -0,0 +1,66 @@
+# Custom Dictionary Words
+
+## Paper related words
+
+Aeschlimann
+Angewandte
+Behnel
+Brockhauser
+Carola
+CSMB
+Dataconverter
+Dobener
+Druskat
+Draxl
+Emminger
+Erlangen
+Faradayweg
+Florian
+Forschungsgemeinschaft
+Ghiringhelli
+Ginzburg
+Großen
+Grundmann
+Haidian
+Heiko
+Hetaba
+Hildebrandt
+Hjorth
+Hoyer
+Jemian
+José
+Klosowski
+Koennecke
+Kühbach
+Laurenz
+Lehrstuhl
+Linnestr
+Lukas
+Márquez
+Markus
+Metainfo
+Mozumder
+Mülheim
+Pielsticker
+Physik
+Pincelli
+Prieto
+RDMS
+RPTU
+Rettig
+Sandor
+Scheidgen
+Shabih
+Sherjeel
+Staudtstr
+Stiftstraße
+Tommaso
+Universität
+Walid
+Windkanal
+Zhongguancun
+dataconverter
+orcid
+plottable
+pynxtools
+qrts

.github/workflows/draft-pdf.yml

@@ -12,6 +12,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Check Spell
+        uses: streetsidesoftware/cspell-action@v7
+        with:
+          files: paper/*.md
+          config: .cspell/cspell.config.yaml
+          strict: true
       - name: Build draft PDF
         uses: openjournals/openjournals-draft-action@master
         with:

.gitignore

@@ -198,6 +198,7 @@ cython_debug/
 .pyenv
 *.pyc
 *.txt
+!.cspell/custom-dictionary.txt
 !requirements.txt
 !dev-requirements.txt
 !mkdocs-requirements.txt