Skip to content

Commit

Permalink
CI: Add a spelling check into CI
Browse files Browse the repository at this point in the history
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 <rgetz@mathworks.com>
  • Loading branch information
rgetz committed Jun 5, 2023
1 parent 43f03ac commit fb2e5eb
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
File renamed without changes.
27 changes: 27 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -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
- '[0-9]+.x'
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

0 comments on commit fb2e5eb

Please sign in to comment.