add codespell CI action (#1190)

* add codespell CI action

* use latest available codespell dictionaries
This commit is contained in:
Daniel Tobias 2024-08-13 15:28:25 +10:00 committed by GitHub
parent 5a9835933d
commit 6ebe0c2b4e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 43 additions and 0 deletions

View File

@ -0,0 +1,6 @@
fram
iterm
ntegral
numer
numers
wel

37
.github/workflows/codespell.yml vendored Normal file
View File

@ -0,0 +1,37 @@
name: Run codespell
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
pull_request:
branches: [ master ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
codespell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# codespell is not installed in the runner by default
- name: install codespell
run: |
sudo apt update
sudo apt install codespell
- name: identify codespell
run: codespell --version
# use latest available dictionaries
- name: update dictionary
run: |
curl --output-dir /tmp --remote-name https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
curl --output-dir /tmp --remote-name https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary_rare.txt
# If count >0 will trigger a workflow failure, else success
- name: run codespell
run: codespell --dictionary=/tmp/dictionary.txt --dictionary=/tmp/dictionary_rare.txt --ignore-words=./.github/workflows/codespell-ignored-words.txt --count ./speeduino/