Add GitHub workflow checking spelling for headers and docs
Run codespell using GitHub Actions to flag any new spelling errors.
This commit is contained in:
43
.github/workflows/code_checks.yml
vendored
Normal file
43
.github/workflows/code_checks.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# This workflow does some quick checks.
|
||||||
|
name: Code Checks
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '.github/workflows/code_checks.yml'
|
||||||
|
- 'docs/**'
|
||||||
|
- 'include/**'
|
||||||
|
- 'interface/**'
|
||||||
|
- 'misc/suppressions/**'
|
||||||
|
- '**/*.md'
|
||||||
|
- '!docs/changes*txt'
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
paths:
|
||||||
|
- '.github/workflows/code_checks.yml'
|
||||||
|
- 'docs/**'
|
||||||
|
- 'include/**'
|
||||||
|
- 'interface/**'
|
||||||
|
- 'misc/suppressions/**'
|
||||||
|
- '**/*.md'
|
||||||
|
- '!docs/changes*txt'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
check-unix:
|
||||||
|
runs-on: ubuntu-20.04
|
||||||
|
name: Check Spelling
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Install codespell
|
||||||
|
run: |
|
||||||
|
sudo apt install codespell
|
||||||
|
|
||||||
|
- name: Run codespell
|
||||||
|
run: |
|
||||||
|
codespell -I misc/suppressions/codespell-words -x misc/suppressions/codespell-lines -S docs/changes.txt -S docs/changes_30.txt -S '*.png' -S '*.ico' -S '*.bmp' -S '*.cur' -S docs/doxygen/images README.md docs include interface
|
Reference in New Issue
Block a user