From: Viktor Szakats <commit@vsz.me>
Date: Thu, 25 Sep 2025 12:50:15 +0000 (+0200)
Subject: GHA: use `pyspelling` directly
X-Git-Tag: rc-8_17_0-2~338
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e48c1ea415d5076082bd2349d066c0df16dc9993;p=thirdparty%2Fcurl.git

GHA: use `pyspelling` directly

To avoid depending on Docker Hub, an Docker image and a GitHub Action.
Also to simplify running this check on a local machine.

Pending question if Dependabot and Mend/Renovate will automatically pick
up `requirements-docs.txt`.

Also:
- enable parallel spellchecking. (also to win back the time lost with
  installing components directly from Debian and pip.)
- pin `pyspelling`.
- link to official `pyspelling` docs.

Closes #18736
---

diff --git a/.github/scripts/requirements-docs.txt b/.github/scripts/requirements-docs.txt
new file mode 100644
index 0000000000..bd50e5010e
--- /dev/null
+++ b/.github/scripts/requirements-docs.txt
@@ -0,0 +1,5 @@
+# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+#
+# SPDX-License-Identifier: curl
+
+pyspelling==2.11
diff --git a/.github/scripts/spellcheck.yaml b/.github/scripts/spellcheck.yaml
index 05ddf0d937..8e26b76189 100644
--- a/.github/scripts/spellcheck.yaml
+++ b/.github/scripts/spellcheck.yaml
@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: curl
 #
+# Docs: https://facelessuser.github.io/pyspelling/configuration/
 # Docs: https://github.com/UnicornGlobal/spellcheck-github-actions
 matrix:
   - name: Markdown
diff --git a/.github/workflows/checkdocs.yml b/.github/workflows/checkdocs.yml
index f236ebc850..a34a341a63 100644
--- a/.github/workflows/checkdocs.yml
+++ b/.github/workflows/checkdocs.yml
@@ -113,13 +113,22 @@ jobs:
           # shellcheck disable=SC2046
           .github/scripts/cleancmd.pl $(find docs -name '*.md')
 
-      - name: 'setup the custom wordlist'
-        run: grep -v '^#' .github/scripts/spellcheck.words > wordlist.txt
-
-      - name: 'check Spelling'
-        uses: rojopolis/spellcheck-github-actions@739a1e3ceb79a98a5d4a9bf76f351137f9d78892 # v0
-        with:
-          config_path: .github/scripts/spellcheck.yaml
+      - name: 'install'
+        run: |
+          sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list
+          sudo apt-get -o Dpkg::Use-Pty=0 update
+          sudo rm -f /var/lib/man-db/auto-update
+          sudo apt-get -o Dpkg::Use-Pty=0 install aspell aspell-en
+          python3 -m venv ~/venv
+          ~/venv/bin/pip --disable-pip-version-check --no-input --no-cache-dir install --progress-bar off --prefer-binary -r .github/scripts/requirements-docs.txt
+
+      - name: 'check spelling'
+        run: |
+          source ~/venv/bin/activate
+          grep -v '^#' .github/scripts/spellcheck.words > wordlist.txt
+          aspell --version
+          pyspelling --version
+          pyspelling --verbose --jobs 5 --config .github/scripts/spellcheck.yaml
 
   badwords-synopsis:
     name: 'badwords, synopsis'