ci: add codespell for grammar errors in code snippets #13
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
| # This workflow checks for common grammar and spelling mistake in markdown docs files. | |
| name: Spellcheck | |
| on: | |
| pull_request: | |
| branches: [main] | |
| jobs: | |
| build: | |
| name: Check Grammar and Spelling errors | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout 🛎️ | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install ⚙️ | |
| run: yarn install --frozen-lockfile | |
| - name: Check spelling errors in code snippets 🔍 | |
| uses: codespell-project/actions-codespell@v2 | |
| with: | |
| check_filenames: true | |
| check_hidden: true | |
| skip: yarn.lock,./node_modules/**/*,./node_modules/.*,./yarn/**/*,./.yarn/**/* | |
| ignore_words_list: datas | |
| - name: Output Spellcheck Results 📝 | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: Spellcheck Output | |
| path: spellcheck-output.txt |