This GitHub Actions runs codespell over your code. Any warnings or errors will be annotated in the Pull Request.

uses: codespell-project/actions-codespell@master

# 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: 
  pull_request_target:

jobs:
  codespell:
    name: Check for spelling errors
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Get changed files
      id: changed-files
      uses: tj-actions/[email protected]

    - name: Get the latest dictionary
      run: |
        wget https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt

    - name: Get the latest rare dictionary
      run: |
        wget https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary_rare.txt    

    - uses: codespell-project/actions-codespell@master
      with:
        dictionary: dictionary.txt,dictionary_rare.txt
        path: ${{ steps.changed-files.outputs.all_changed_files }}

If set, check file names for spelling mistakes as well.

This parameter is optional; by default codespell will only check the file contents.

uses: codespell-project/actions-codespell@master
with:
  check_filenames: true

If set, check hidden files (those starting with ".") for spelling mistakes as well.

This parameter is optional; by default codespell will not check hidden files.

uses: codespell-project/actions-codespell@master
with:
  check_hidden: true

File with lines that should not be checked for spelling mistakes.

This parameter is optional; by default codespell will check all lines.

uses: codespell-project/actions-codespell@master
with:
  exclude_file: src/foo

Comma-separated list of files to skip (it accepts globs as well).

This parameter is optional; by default codespell won't skip any files.

uses: codespell-project/actions-codespell@master
with:
  skip: foo,bar

Comma-separated list of custom dictionaries to use. This parameter is optional; by default codespell will use the builtin dictionaries.

uses: codespell-project/actions-codespell@master
with:
  dictionary: dictionary.txt,dictionary2.txt

Comma-separated list of builtin dictionaries to use.

This parameter is optional; by default codespell will use its default selection of built in dictionaries.

uses: codespell-project/actions-codespell@master
with:
  builtin: clear,rare

custom dictionary file that contains spelling corrections. If this flag is not specified or equals "-" then the default dictionary is used. This parameter is optional;

uses: codespell-project/actions-codespell@master
with:
  dictionary: dictionary.txt

File that contains words which will be ignored by codespell. File must contain one word per line. Words are case sensitive based on how they are written in the dictionary file.

This parameter is optional; by default codespell will check all words for typos.

uses: codespell-project/actions-codespell@master
with:
  ignore_words_file: .codespellignore

Comma-separated list of words which will be ignored by codespell. Words are case sensitive based on how they are written in the dictionary file.

This parameter is optional; by default codespell will check all words for typos.

uses: codespell-project/actions-codespell@master
with:
  ignore_words_list: abandonned,ackward

Indicates the path to run codespell in. This can be useful if your project has code you don't want to spell check for some reason.

This parameter is optional; by default codespell will run on your whole repository.

uses: codespell-project/actions-codespell@master
with:
  path: src

Only warn about problems. All errors and warnings are annotated in Pull Requests, but it will act like everything was fine anyway. (In other words, the exit code is always 0.)

This parameter is optional; setting this to any value will enable it.

uses: codespell-project/actions-codespell@master
with:
  only_warn: 1