Commit 42d8a20
committed
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.1 parent 05b7dfe commit 42d8a20
3 files changed
Lines changed: 31 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,7 @@ | |||
| 1 | + # See: https://github.com/codespell-project/codespell#using-a-config-file | ||
| 2 | + [codespell] | ||
| 3 | + # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: | ||
| 4 | + ignore-words-list = , | ||
| 5 | + check-filenames = | ||
| 6 | + check-hidden = | ||
| 7 | + skip = ./.git | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,22 @@ | |||
| 1 | + name: Spell Check | ||
| 2 | + | ||
| 3 | + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows | ||
| 4 | + on: | ||
| 5 | + push: | ||
| 6 | + pull_request: | ||
| 7 | + schedule: | ||
| 8 | + # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates. | ||
| 9 | + - cron: "0 8 * * TUE" | ||
| 10 | + workflow_dispatch: | ||
| 11 | + repository_dispatch: | ||
| 12 | + | ||
| 13 | + jobs: | ||
| 14 | + spellcheck: | ||
| 15 | + runs-on: ubuntu-latest | ||
| 16 | + | ||
| 17 | + steps: | ||
| 18 | + - name: Checkout repository | ||
| 19 | + uses: actions/checkout@v2 | ||
| 20 | + | ||
| 21 | + - name: Spell check | ||
| 22 | + uses: codespell-project/actions-codespell@master | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,7 @@ | |||
| 1 | 1 | # ArduinoHttpClient | |
| 2 | 2 | ||
| 3 | + [](https://github.com/arduino-libraries/ArduinoHttpClient/actions/workflows/spell-check.yml) | ||
| 4 | + | ||
| 3 | 5 | ArduinoHttpClient is a library to make it easier to interact with web servers from Arduino. | |
| 4 | 6 | ||
| 5 | 7 | Derived from [Adrian McEwen's HttpClient library](https://github.com/amcewen/HttpClient) | |
0 commit comments