aboutsummaryrefslogtreecommitdiff
path: root/.github/workflows/spell-check.yml
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 /.github/workflows/spell-check.yml
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.
Diffstat (limited to '.github/workflows/spell-check.yml')
-rw-r--r--.github/workflows/spell-check.yml22
1 files changed, 22 insertions, 0 deletions
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