Skip to content

ci: add codespell for grammar errors in code snippets #6

ci: add codespell for grammar errors in code snippets

ci: add codespell for grammar errors in code snippets #6

Workflow file for this run

# This workflow checks for common grammar and spelling mistake in markdown docs files.
name: Spellcheck
on:
pull_request:
branches: [main]
jobs:
build:
name: Spellcheck
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 docs content 📝
# uses: rojopolis/[email protected]
# with:
# source_files: docs/**/*.md docs/**/*.mdx
# task_name: Markdown
# output_file: spellcheck-output.txt
- name: Check spelling errors in code snippets 🔍
# Spellcheck can also check code snippets but has limited support for some languages
# Solidity code seems to not be supported.
# See: https://github.com/rojopolis/spellcheck-github-actions
uses: codespell-project/actions-codespell@v2
with:
check_filenames: true
check_hidden: true
skip: yarn.lock,node_modules/**/*
- name: Output Spellcheck Results 📝
uses: actions/upload-artifact@v3
with:
name: Spellcheck Output
path: spellcheck-output.txt