Skip to content

Commit

Permalink
ci: add CI workflow to check for grammar errors
Browse files Browse the repository at this point in the history
  • Loading branch information
b00ste committed Nov 26, 2024
1 parent b721bc5 commit 6b159ca
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# This workflow checks for common grammar and spelling mistake in markdown files.
name: Spellcheck
on: [pull_request]

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: npm ci

- name: Check spelling errors in code snippets 🔍
uses: codespell-project/actions-codespell@v2
with:
path: packages/lsp-smart-contracts/docs
check_filenames: true
ignore_words_list: datas

- name: Output Spellcheck Results 📝
uses: actions/upload-artifact@v3
with:
name: Spellcheck Output
path: spellcheck-output.txt

0 comments on commit 6b159ca

Please sign in to comment.