aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorper1234 <accounts@perglass.com>2021-05-26 03:56:23 -0700
committerper1234 <accounts@perglass.com>2021-05-26 04:39:38 -0700
commit5ec42f90eed49e886eb96ad156b4332ab3d21493 (patch)
tree298c1589dad6ba8b2f1d119ee46df073b138b9c0
parentde717ce81dc21009ae6ed4870908b4b5a5c616e2 (diff)
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.
-rw-r--r--.codespellrc7
-rw-r--r--.github/workflows/spell-check.yml22
-rw-r--r--README.md2
3 files changed, 31 insertions, 0 deletions
diff --git a/.codespellrc b/.codespellrc
new file mode 100644
index 0000000..6aace1d
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,7 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = hart,pullrequest
+check-filenames =
+check-hidden =
+skip = ./.git,./firmwares/arduinoISP,./firmwares/wifishield,./bootloaders
diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml
new file mode 100644
index 0000000..01bee87
--- /dev/null
+++ b/.github/workflows/spell-check.yml
@@ -0,0 +1,22 @@
+name: Spell Check
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+ push:
+ pull_request:
+ schedule:
+ # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
+ - cron: "0 8 * * TUE"
+ workflow_dispatch:
+ repository_dispatch:
+
+jobs:
+ spellcheck:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v2
+
+ - name: Spell check
+ uses: codespell-project/actions-codespell@master
diff --git a/README.md b/README.md
index 88d0b6f..5f3471e 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
# Arduino AVR Boards
+[![Spell Check status](https://github.com/arduino/ArduinoCore-avr/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino/ArduinoCore-avr/actions/workflows/spell-check.yml)
+
This repository contains the source code and configuration files of the Arduino AVR Boards
[platform](https://arduino.github.io/arduino-cli/latest/platform-specification/).