peternewman/actions-codespell

Codespell with GitHub Actions -- including annotations for Pull Requests

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

Usage

uses: peternewman/actions-codespell@master

Parameter: path

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: peternewman/actions-codespell@master
with:
  path: src

Parameter: only_warn

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: peternewman/actions-codespell@master
with:
  only_warn: 1