Skip to content

Commit 93aaa04

Browse files
committed
Add CI workflow to check for commonly misspelled words
In the event of a false positive, the problematic word should be added, in all lowercase, to extras/codespell-ignore-words-list.txt, after which it will be ignored by the action.
1 parent cc2fb71 commit 93aaa04

File tree

3 files changed

+27
-0
lines changed

3 files changed

+27
-0
lines changed

.github/workflows/spell-check.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Spell Check
2+
3+
on:
4+
pull_request:
5+
push:
6+
schedule:
7+
# run every Tuesday at 3 AM UTC
8+
- cron: "0 3 * * 2"
9+
10+
jobs:
11+
spellcheck:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@v2
17+
18+
# See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
19+
- name: Spell check
20+
uses: codespell-project/actions-codespell@master
21+
with:
22+
check_filenames: true
23+
check_hidden: true
24+
# In the event of a false positive, add the word in all lower case to this file:
25+
ignore_words_file: extras/codespell-ignore-words-list.txt
26+
skip: ./.git

README.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
= {repository-name} library for Arduino =
66

77
image:https://github.com/{repository-owner}/{repository-name}/workflows/Compile%20Examples/badge.svg["Compile Examples Status", link="https://github.com/{repository-owner}/{repository-name}/actions?workflow=Compile+Examples"]
8+
image:https://github.com/{repository-owner}/{repository-name}/workflows/Spell%20Check/badge.svg["Spell Check Status", link="https://github.com/{repository-owner}/{repository-name}/actions?workflow=Spell+Check"]
89

910
The {repository-name} library enables an Arduino SAMD Board (e.g., https://store.arduino.cc/catalogsearch/result/?q=mkr[MKR boards], https://store.arduino.cc/arduino-nano-33-iot[Nano 33 IoT], https://store.arduino.cc/arduino-zero[Zero]) to play back .wav files from a storage device like an SD card to the `DAC0`/`A0` pin.
1011
For more information about this library please visit us at

extras/codespell-ignore-words-list.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)