From 7a1269e12a4ffeb75d88f30c856c8158448bf4d9 Mon Sep 17 00:00:00 2001 From: Robin Getz Date: Mon, 5 Jun 2023 15:54:59 -0400 Subject: [PATCH] CI: Add a spelling check into CI use codespell to make sure that everyone is aware of their bad spelling, and make sure to point it out during the commit process. Signed-off-by: Robin Getz --- .codespell-whitelist => .codespell-ignore.txt | 0 .github/workflows/codespell.yml | 27 +++++++++++++++++++ 2 files changed, 27 insertions(+) rename .codespell-whitelist => .codespell-ignore.txt (100%) create mode 100644 .github/workflows/codespell.yml diff --git a/.codespell-whitelist b/.codespell-ignore.txt similarity index 100% rename from .codespell-whitelist rename to .codespell-ignore.txt diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 000000000..1d7471eea --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,27 @@ +# GitHub Action to automate the identification of common misspellings in text files. +# https://github.com/codespell-project/actions-codespell +# https://github.com/codespell-project/codespell +name: codespell +on: + push: + branches: + - main + - master + pull_request: + branches: + - main + - master + +permissions: + contents: read # to fetch code (actions/checkout) +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: codespell-project/actions-codespell@v1 # v1.0 + with: + check_filenames: true + skip: .git,deps + ignore_words_file: .codespell-ignore.txt