Skip to content

Commit b826483

Browse files
committed
Add spell-check GitHub Actions workflow
The repository will be checked for commonly misspelled words on every pull request and push. In the event of false positives, add the word you wish the check to ignore to etc/codespell-ignore-words-list.txt. Always use lowercase, as the ignore words list is case-sensitive and the list of commonly misspelled words is in lowercase.
1 parent 821c7fa commit b826483

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

.github/workflows/spell-check.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Spell Check
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
spellcheck:
7+
runs-on: ubuntu-latest
8+
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v2
12+
13+
- name: Spell check
14+
uses: ./libraries/spell-check
15+
with:
16+
ignore-words-list: etc/codespell-ignore-words-list.txt
17+
skip-paths: ./libraries/spell-check/test/testdata,./setup-taskfile/node_modules,./setup-taskfile/package-lock.json

etc/codespell-ignore-words-list.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
afterall
2+
clude

0 commit comments

Comments
 (0)