docs: add auto testing of examples #2278
Workflow file for this run
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: Docs PR Spellcheck | |
| on: | |
| pull_request: | |
| branches: | |
| - 'dev' | |
| files: | |
| - '**Doxyfile' | |
| - '**docpages/**' | |
| - '**/*.h' | |
| - '**/documentation-check.yml' | |
| push: | |
| files: | |
| - '**/documentation-check.yml' | |
| jobs: | |
| docs: | |
| name: Check Documentation Spelling | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Harden Runner | |
| uses: step-security/harden-runner@8ca2b8b2ece13480cda6dacd3511b49857a23c09 # v2.5.1 | |
| with: | |
| egress-policy: audit | |
| - name: Checkout D++ | |
| uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3.6.0 | |
| - 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 |