Skip to content

Commit 1623755

Browse files
committed
Use official codespell action for spell check CI
The arduino/actions/libraries/spell-check action previously in use is deprecated. 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 4038f62 commit 1623755

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

.codespellrc

+7
Original file line numberDiff line numberDiff 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,./extras/TrustAnchors,./src/bearssl

.github/workflows/spell-check.yml

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
name: Spell Check
22

3-
on: [push, pull_request]
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:
412

513
jobs:
614
spellcheck:
715
runs-on: ubuntu-latest
816

917
steps:
10-
- name: Checkout
18+
- name: Checkout repository
1119
uses: actions/checkout@v2
1220

1321
- name: Spell check
14-
uses: arduino/actions/libraries/spell-check@master
15-
with:
16-
ignore-words-list: extras/codespell-ignore-words-list.txt
17-
skip-paths: ./extras/TrustAnchors,./src/bearssl
22+
uses: codespell-project/actions-codespell@master

extras/codespell-ignore-words-list.txt

Whitespace-only changes.

0 commit comments

Comments
 (0)