Add a simple spellchecker to weed out common typos etc. in the docs. #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Spell Checking | |
on: | |
pull_request: | |
types: | |
- opened | |
- reopened | |
- synchronize | |
branches: | |
- master | |
paths-ignore: | |
- '**/*.py' | |
- '**/*.yml' | |
- '.gitignore' | |
push: | |
branches: | |
- master | |
tags: | |
- v** | |
jobs: | |
check-spelling: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repository contents | |
uses: actions/checkout@v3 | |
- name: Check Spelling of docs | |
uses: rojopolis/spellcheck-github-actions@0.36.0 | |
with: | |
config_path: .spellcheck.yml | |
task_name: Markdown |