Add codespell workflow (#2807)

* codespell workflow

* use micromamba

* Update env name

* Checkout PR's code when event is pull request target

* Update codespell configuration

* update codespell command to run in docs only

* Remove codespell version while installation

* Remove unwanted warnings from the logs

* Run codespell manually

.github/workflows/codespell.yml

@@ -0,0 +1,39 @@
+name: codespell
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+  pull_request_target:
+    branches:
+      - master
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        if: github.event_name != 'pull_request_target'
+
+      - name: Checkout pull/${{ github.event.number }}
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
+        if: github.event_name == 'pull_request_target'
+
+      - name: Setup micromamba
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-name: fetch-env
+          create-args: >-
+            python
+
+      - name: Install Codespell
+        run: pip install codespell
+
+      - name: Run codespell
+        run: |
+          codespell docs/

pyproject.toml

@@ -214,4 +214,8 @@ sort_commits = "newest"
 
 [tool.git-cliff.remote.github]
 owner = "tardis-sn"
-repo = "tardis"
+repo = "tardis"
+
+[tool.codespell]
+skip = "*.png,*.ggb,*.jpg,*.gif,*.ico,docs/contributing/CHANGELOG.md,docs/tardis.bib"
+quiet-level = 3