From e4a826d25073ff1e9a9de6bedf3cdc1ca2896c12 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 13 Jul 2020 17:11:21 +0200 Subject: [PATCH] Add GitHub workflow checking spelling for headers and docs Run codespell using GitHub Actions to flag any new spelling errors. --- .github/workflows/code_checks.yml | 43 +++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/workflows/code_checks.yml diff --git a/.github/workflows/code_checks.yml b/.github/workflows/code_checks.yml new file mode 100644 index 0000000000..0e16b0a147 --- /dev/null +++ b/.github/workflows/code_checks.yml @@ -0,0 +1,43 @@ +# This workflow does some quick checks. +name: Code Checks + +on: + push: + branches: + - master + paths: + - '.github/workflows/code_checks.yml' + - 'docs/**' + - 'include/**' + - 'interface/**' + - 'misc/suppressions/**' + - '**/*.md' + - '!docs/changes*txt' + pull_request: + branches: + - master + paths: + - '.github/workflows/code_checks.yml' + - 'docs/**' + - 'include/**' + - 'interface/**' + - 'misc/suppressions/**' + - '**/*.md' + - '!docs/changes*txt' + +jobs: + check-unix: + runs-on: ubuntu-20.04 + name: Check Spelling + + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Install codespell + run: | + sudo apt install codespell + + - name: Run codespell + run: | + codespell -I misc/suppressions/codespell-words -x misc/suppressions/codespell-lines -S docs/changes.txt -S docs/changes_30.txt -S '*.png' -S '*.ico' -S '*.bmp' -S '*.cur' -S docs/doxygen/images README.md docs include interface