Run codespell from a separate script in GitHub workflow

This allows to give a more detailed error message in case of a problem
and also makes it simpler to run the spell check locally.
This commit is contained in:
Vadim Zeitlin
2020-07-18 19:38:20 +02:00
parent 96bac38274
commit e875b11f74
2 changed files with 35 additions and 1 deletions

View File

@@ -39,5 +39,7 @@ jobs:
pip3 install --no-warn-script-location codespell==1.17.1
- name: Run codespell
env:
CODESPELL: $HOME/.local/bin/codespell
run: |
$HOME/.local/bin/codespell -I misc/suppressions/codespell-words -x misc/suppressions/codespell-lines -S 'docs/changes.txt,docs/changes_30.txt,*.png,*.ico,*.bmp,*.cur,docs/doxygen/images' README.md docs include interface
./misc/scripts/spellcheck

32
misc/scripts/spellcheck Executable file
View File

@@ -0,0 +1,32 @@
#!/bin/sh
CODESPELL=${CODESPELL-codespell}
# Make sure we run codespell from the top wx directory.
cd `dirname "$0"`/../..
if ! command -v $CODESPELL > /dev/null; then
echo "ERROR: codespell not available." >&2
exit 127
fi
$CODESPELL \
-I misc/suppressions/codespell-words \
-x misc/suppressions/codespell-lines \
-S 'docs/changes.txt,docs/changes_30.txt,*.png,*.ico,*.bmp,*.cur,docs/doxygen/images' \
README.md docs include interface
rc=$?
if [ $rc != 0 ]; then
cat <<EOF
=================================== ERROR ===================================
Spell check failed, please correct the spelling mistakes at the locations
listed above. If any of the reported mistakes are false positives, please add
the lines provoking them to misc/suppressions/codespell-lines file or, if
there are many occurrences of the same word, add this word to codespell-words
file in the same directory.
EOF
>& 2
exit $rc
fi