From af75a3c590bd35275b69856645e7a25eb221154f Mon Sep 17 00:00:00 2001
From: Jazz Turner-Baggs <473256+jazzz@users.noreply.github.com>
Date: Thu, 27 Feb 2025 06:59:38 -0800
Subject: [PATCH] Incremental spellcheck action (#55)

* chore: add incremental spellcheck

* chore: upgrade repo wide spellcheck
---
 .github/workflows/spelling-incremental.yml | 28 +++++++++++++++
 .github/workflows/spelling.yml             | 23 +++++--------
 .spellcheck.yml                            | 17 +++++++++
 .wordlist.txt                              | 23 +++++++++++++
 spellcheck.yaml                            | 40 ----------------------
 5 files changed, 76 insertions(+), 55 deletions(-)
 create mode 100644 .github/workflows/spelling-incremental.yml
 create mode 100644 .spellcheck.yml
 create mode 100644 .wordlist.txt
 delete mode 100644 spellcheck.yaml

diff --git a/.github/workflows/spelling-incremental.yml b/.github/workflows/spelling-incremental.yml
new file mode 100644
index 0000000..320589a
--- /dev/null
+++ b/.github/workflows/spelling-incremental.yml
@@ -0,0 +1,28 @@
+name: Spellcheck(Incremental)
+
+on:
+  pull_request:
+    branches: 
+      - '**'
+  workflow_dispatch:
+
+jobs:
+  spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get all changed markdown files
+        uses: tj-actions/changed-files@v45
+        id: changed_files
+        with:
+          files: |
+            **.md
+            
+      - name: Run Spellcheck
+        id: spellcheck
+        uses: rojopolis/spellcheck-github-actions@v0
+        with:
+          task_name: Markdown
+          source_files: ${{ steps.changed_files.outputs.all_changed_files }}
+          config_path: .spellcheck.yml
diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
index e1ece9e..3fc3a7e 100644
--- a/.github/workflows/spelling.yml
+++ b/.github/workflows/spelling.yml
@@ -1,25 +1,18 @@
-name: Spellcheck
+name: Spellcheck(Repo)
 
 on:
-  push:
-    branches: 
-      - '**'
-  pull_request:
-    branches: 
-      - '**'
+  schedule:
+    - cron: "0 0 * * 2"   # Every Tuesday
   workflow_dispatch:
 
 jobs:
   spellcheck:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Install aspell
-        run: sudo apt-get install -y aspell aspell-en
-
-      - name: Run spellcheck
-        uses: igsekor/pyspelling-any@v1.0.4
+      - name: Run Spellcheck
+        uses: rojopolis/spellcheck-github-actions@v0
         with:
-          args: "-c ./spellcheck.yaml"
-
+          task_name: Markdown
+          config_path: .spellcheck.yml
diff --git a/.spellcheck.yml b/.spellcheck.yml
new file mode 100644
index 0000000..33142a5
--- /dev/null
+++ b/.spellcheck.yml
@@ -0,0 +1,17 @@
+matrix:
+- name: Markdown
+  sources:
+    - '**/*.md' 
+  expect_match: false   # false -> supress errors if no markdown files were edited
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+  encoding: utf-8
+  pipeline:
+    - pyspelling.filters.markdown
+    - pyspelling.filters.text
+  default_encoding: utf-8
+  suggest: true
+
diff --git a/.wordlist.txt b/.wordlist.txt
new file mode 100644
index 0000000..4d6c057
--- /dev/null
+++ b/.wordlist.txt
@@ -0,0 +1,23 @@
+ALLOC
+IANA
+SHARDING
+WAKU
+Waku
+danielkaiser
+creativecommons
+github
+GITHUB
+https
+iana
+md
+rfc
+RFC
+www
+DHT
+DoS
+GossipSub
+gossipsub
+libp2p
+pubsub
+subnets
+ZXCV
\ No newline at end of file
diff --git a/spellcheck.yaml b/spellcheck.yaml
deleted file mode 100644
index 2684db4..0000000
--- a/spellcheck.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-matrix:
-- name: markdown
-  sources:
-  - '**/*.md'
-  default:
-    dictionary: 
-    - en_US
-    - en_GB
-    encoding: utf-8
-    pipeline:
-      - pyspelling.filters.markdown:
-          extensions:
-            - .md
-      - pyspelling.filters.text
-    sources:
-      - '**/*.md'
-    suggest: true
-    whitelist:
-    - ALLOC
-      - IANA
-      - SHARDING
-      - WAKU
-      - Waku
-      - danielkaiser
-      - creativecommons
-      - github
-      - GITHUB
-      - https
-      - iana
-      - md
-      - rfc
-      - RFC
-      - www
-      - DHT
-      - DoS
-      - GossipSub
-      - gossipsub
-      - libp2p
-      - pubsub
-      - subnets