feat(docs): add CI Spell check #4
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: Check Spelling | |
| on: | |
| push: | |
| branches: | |
| - '**' # Trigger on all branches | |
| pull_request: | |
| branches: | |
| - '**' # Trigger on all branches | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| jobs: | |
| spelling: | |
| name: Check Spelling | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| actions: read | |
| security-events: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.x' | |
| - name: Install check-spelling tool | |
| uses: check-spelling/check-spelling@v1 | |
| with: | |
| config: .github/spelling.yml | |
| - name: Run spell check | |
| id: spell-check | |
| run: | | |
| check-spelling --files '**/*.mdx' || true | |
| - name: Report results | |
| if: failure() | |
| run: | | |
| echo "Spell check failed. See the results above." |