Prepare the v0.12.0 release (#718)

* Prepare the v0.12.0 release, spellchecking is now performed before the mkdocs deployment

* Update cspell configuration to match that used in the pynx plugins and adding words so far missing

---------

Co-authored-by: mkuehbach <markus.kuehbach@physik.hu-berlin.de>

Author: mkuehbach

.cspell/custom-dictionary.txt

@@ -1,119 +1,112 @@
 # Custom Dictionary Words
-
-## NeXus related words
+ARPES
 AXISNAME
-namefitting
-NIAC
-NXDL
-
-## LateX, XML
-
-# Words related to experimental techniques
-
-# Software
+Aeschlimann
 BASECLASS
-caplog
-cnxvalidate
-dataconverter
-DECTRIS
-electronanalyzer
-ELECTRONANALYZER
-ellipsometry
-GROUPNAME
-infty
-libiconv
-loadgroup
-mainfile
-Metainfo
-MSYS
-nexpy
-nexusformat
-nxdls
-PATHCONV
-pathtovalidate
-posint
-punx
-pynxtools
-xarrays
-xdist
-Zenodo
-
-# examples
-alphabetagamma
-appdefdir
-CSET
-ellips
-FAIRMAT
-filemanager
-fxcef
-hildebrandt
-hixu
-infile
-kfra
-libhdf
-mydata
-mydatareader
-mynxdl
-nexusvalidate
-nexusvalidation
-NULLTERM
-otherfile
-physik
-STRPAD
-STRSIZE
-xfbaa
-
-# related to experimental techniques
-arpes
-ARPES
 Bluesky
-emittance
-flatfield
-fluence
-mbar
-monochromator
-monoclinic
-MPES
-Raman
-setpoint
-xraylens
-
-# Names
 Brockhauser
 Brückner
+CSET
+Carola
+DECTRIS
 Dobener
 Draxl
+ELECTRONANALYZER
+Emminger
+FAIRMAT
 Fekete
+Florian
 Forschungsgemeinschaft
+GROUPNAME
 Ginzburg
+Grundmann
 Haraszti
+Heiko
+Hetaba
 José
 Kühbach
+Laurenz
 Lukas
-lukaspie
+MPES
+MSYS
 Maier
 Markus
-Márquez
-mkuehbach
+Metainfo
 Mozumder
+Márquez
 NFDI
+NIAC
+NULLTERM
+NXDL
+PATHCONV
 Pielsticker
+Pincelli
+Prieto
+Raman
 Rettig
+STRPAD
+STRSIZE
+Sandor
 Scheidgen
 Shabih
 Sherjeel
-sherjeelshabih
-tommaso
-
-# other languages
-
-# en-UK
+Walid
+Zenodo
+alphabetagamma
 analyser
-oxidising
-
-# misc
 appdef
+appdefdir
 appdefs
+arpes
+caplog
+cnxvalidate
+dataconverter
+electronanalyzer
+ellips
+ellipsometry
+emittance
+filemanager
+flatfield
+fluence
+fxcef
+hildebrandt
+hixu
 hypothes
+infile
+infty
+kfra
+libhdf
+libiconv
+loadgroup
+lukaspie
+mainfile
+mbar
+mkuehbach
+monochromator
+monoclinic
+mydata
+mydatareader
+mynxdl
+namefitting
+nexpy
+nexusformat
+nexusvalidate
+nexusvalidation
+nxdls
+orcid
+otherfile
+oxidising
+pathtovalidate
+physik
 plottable
-underload
+posint
+punx
+pynxtools
+setpoint
+sherjeelshabih
+tommaso
+underload
+xarrays
+xdist
+xfbaa
+xraylens

.github/workflows/build_docs.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       - master  # Triggers deployment on push to the master branch
-  
+
 env:
   python-version: 3.12
 
@@ -27,15 +27,6 @@ jobs:
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
 
-      - name: Check spelling
-        uses: streetsidesoftware/cspell-action@v7
-        with:
-          files: |
-            docs/**/*.md
-            README.md
-          strict: true
-          incremental_files_only: false
-
       - name: Install uv and set the python version to ${{ env.python-version }}
         uses: astral-sh/setup-uv@v5
         with:

.github/workflows/spellcheck.yaml

@@ -0,0 +1,29 @@
+name: Spell Check
+
+on:
+  pull_request:
+    branches:
+      - master  # Triggers deployment on push to the master branch
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install dependencies and dictionary
+      run: |
+        npm install -g cspell jq @cspell/dict-scientific-terms-us
+
+    - name: Run cspell
+      run: |
+        cspell --config cspell.json "docs/**/*.md" "CITATION.cff" "README.md"
+
+    - name: Fail on errors
+      run: |
+        if [[ $? -ne 0 ]]; then
+          echo "There are spelling errors in your code. Please fix them and try again."
+          exit 1
+        fi

CITATION.cff

@@ -4,7 +4,7 @@ message:
   If you use this software, please cite it using the
   metadata from this file.
 type: software
-version: 0.11.1
+version: 0.12.0
 authors:
   - given-names: Sherjeel
     family-names: Shabih

cspell.json

@@ -3,6 +3,7 @@
     "ignorePaths": [
         "./tests/data/*",
         "*.toml",
+        "Makefile",
         "*.bat",
         "*.egg-info"
     ],
@@ -13,8 +14,10 @@
             "addWords": true
         }
     ],
+    "import": ["@cspell/dict-scientific-terms-us/cspell-ext.json"],
     "dictionaries": [
         "custom-dictionary",
+        "scientific_terms_US",
         "python"
     ],
     "words": [],

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=64.0.1", "setuptools-scm[toml]>=6.2"]
+requires = ["setuptools>=78.1.1", "setuptools-scm[toml]>=6.2"]
 backend-path = ["src/pynxtools"]
 build-backend = "_build_wrapper"
 
@@ -38,7 +38,6 @@ dependencies = [
     "pint",
     "cachetools",
     "structlog",
-
 ]
 
 [project.urls]