Skip to content

Commit

Permalink
ci: move action to spellcheck CI workflow + adjust files to check
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ42 committed Nov 25, 2024
1 parent 88bf41f commit 0f73ade
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 13 deletions.
6 changes: 0 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,6 @@ jobs:
- name: Prettier 🎨
run: yarn run prettier

- name: Check spelling errors in code snippets πŸ”
uses: codespell-project/actions-codespell@v2
with:
check_filenames: true
check_hidden: true

- name: Build 🧱
run: yarn run build

Expand Down
16 changes: 9 additions & 7 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# This workflow checks for common grammar and spelling mistake in markdown docs files.
name: Spellcheck
on: workflow_dispatch
on:
pull_request:
branches: [main]

jobs:
build:
name: Spellcheck
name: Check Grammar and Spelling errors
runs-on: ubuntu-latest
steps:
- name: Checkout πŸ›ŽοΈ
Expand All @@ -15,12 +17,12 @@ jobs:
- name: Install βš™οΈ
run: yarn install --frozen-lockfile

- name: Spellcheck πŸ“
uses: rojopolis/spellcheck-github-actions@0.33.0
- name: Check spelling errors in code snippets πŸ”
uses: codespell-project/actions-codespell@v2
with:
source_files: docs/**/*.md docs/**/*.mdx
task_name: Markdown
output_file: spellcheck-output.txt
check_filenames: true
check_hidden: true
skip: yarn.lock,./node_modules/**/*,./node_modules/.*,./yarn/**/*,./.yarn/**/*

- name: Output Spellcheck Results πŸ“
uses: actions/upload-artifact@v3
Expand Down

0 comments on commit 0f73ade

Please sign in to comment.