From 0c3b61cfea4e8aa96bc8953f0ced98618b878c50 Mon Sep 17 00:00:00 2001 From: Jauder Ho Date: Mon, 3 Jan 2022 17:44:24 -0800 Subject: [PATCH] Add codespell. This identified a number of typos (#824) * Add codespell. This identified a number of typos * Update codespell.yml Ignore docs/src/data/english-words.txt --- .codespellignore | 0 .github/workflows/codespell.yml | 35 +++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 .codespellignore create mode 100644 .github/workflows/codespell.yml diff --git a/.codespellignore b/.codespellignore new file mode 100644 index 000000000..e69de29bb diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 000000000..6a6e7f431 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,35 @@ +name: Codespell + +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions + +# Start the job on all push # +on: + push: + pull_request: + workflow_dispatch: + +# Set the Job # +jobs: + build: + name: Codespell + # Set the agent to run on + runs-on: ubuntu-latest + + # Load all steps # + steps: + # Checkout the code base # + - name: Checkout Code + uses: actions/checkout@v2.4.0 + with: + # Full git history is needed to get a proper list of changed files within `super-linter` + fetch-depth: 0 + + # Run Linter against code base # + - name: Codespell + uses: codespell-project/actions-codespell@master + with: + check_filenames: true + ignore_words_file: .codespellignore + exclude_file: docs/src/data/english-words.txt +