34 lines
879 B
YAML
34 lines
879 B
YAML
|
name: Docs PR Spellcheck
|
||
|
|
on:
|
||
|
|
pull_request:
|
||
|
|
branches:
|
||
|
|
- 'dev'
|
||
|
|
files:
|
||
|
|
- '**Doxyfile'
|
||
|
|
- '**docpages/**'
|
||
|
|
- '**/*.h'
|
||
|
|
- '**/documentation-check.yml'
|
||
|
|
push:
|
||
|
|
files:
|
||
|
|
- '**/documentation-check.yml'
|
||
|
|
|
||
|
|
permissions:
|
||
|
|
contents: read # This only needs to read the contents of a PR.
|
||
|
|
|
||
|
|
jobs:
|
||
|
|
docs:
|
||
|
|
name: Check Documentation Spelling
|
||
|
|
runs-on: ubuntu-20.04
|
||
|
|
|
||
|
|
steps:
|
||
|
|
- name: Harden Runner
|
||
|
|
uses: step-security/harden-runner@eb238b55efaa70779f274895e782ed17c84f2895 # v2.6.1
|
||
|
|
with:
|
||
|
|
egress-policy: audit
|
||
|
|
|
||
|
|
- name: Checkout D++
|
||
|
|
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||
|
|
|
||
|
|
- name: Check docs spelling
|
||
|
|
run: npx -y cspell lint --language-id=cpp --no-progress --no-summary --show-context --show-suggestions --relative --color docpages/*.md include/dpp/*.h
|