From 6df0e09c41eb73c209593a4e23aaec048090feeb Mon Sep 17 00:00:00 2001
From: per1234 <accounts@perglass.com>
Date: Tue, 12 Jan 2021 21:48:06 -0800
Subject: [PATCH] Add CI workflow to check for commonly misspelled words

On every push, pull request, and periodically, use the codespell-project/actions-codespell action to check for commonly
misspelled words.

In the event of a false positive, the problematic word should be added, in all lowercase, to the ignore-words-list field
of ./.codespellrc. Regardless of the case of the word in the false positive, it must be in all lowercase in the ignore
list. The ignore list is comma-separated with no spaces.
---
 .codespellrc                      |  6 ++++++
 .github/workflows/spell-check.yml | 24 ++++++++++++++++++++++++
 README.adoc                       |  1 +
 3 files changed, 31 insertions(+)
 create mode 100644 .codespellrc
 create mode 100644 .github/workflows/spell-check.yml

diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 00000000..3dd012ad
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,6 @@
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = endianess
+check-filenames =
+check-hidden =
+skip = ./.git
diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml
new file mode 100644
index 00000000..7ad14758
--- /dev/null
+++ b/.github/workflows/spell-check.yml
@@ -0,0 +1,24 @@
+name: Spell Check
+
+on:
+  pull_request:
+  push:
+  schedule:
+    # Run every Saturday at 3 AM UTC to catch new misspelling detections resulting from dictionary updates.
+    - cron: "0 3 * * 6"
+  # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch
+  workflow_dispatch:
+  # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#repository_dispatch
+  repository_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master
diff --git a/README.adoc b/README.adoc
index 8dfd4600..cba68605 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,4 +1,5 @@
 = WiFiNINA Library for Arduino =
+= {repository-name} library for Arduino =
 
 image:https://travis-ci.org/arduino-libraries/WiFiNINA.svg?branch=master["Build Status", link="https://travis-ci.org/arduino-libraries/WiFiNINA"]