diff options
Diffstat (limited to '.github/workflows/codespell-docs.yml')
| -rw-r--r-- | .github/workflows/codespell-docs.yml | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/.github/workflows/codespell-docs.yml b/.github/workflows/codespell-docs.yml new file mode 100644 index 0000000..d6409a1 --- /dev/null +++ b/.github/workflows/codespell-docs.yml @@ -0,0 +1,57 @@ +# Codespell configuration inlined in this workflow (no .codespellrc needed) +--- +name: Codespell + +on: + push: + branches: ['**'] + pull_request: + branches: ['**'] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + + - name: Codespell + uses: codespell-project/actions-codespell@v2 + with: + path: ./docs/ + # filenames and hidden files + check_filenames: true + check_hidden: true + # skip list + skip: | + .git + .husky + .vscode + .idea + .venv + venv + node_modules + dist + build + out + coverage + *.lock + *.min.js + *.svg + *.pdf + *.png + *.jpg + package.json + package-lock.json + # Optional: Proper Noun Whitelist File + ignore_words_file: .codespellignore + # Fail CI on errors, set to true to only warn + only_warn: true |