Skip to content

Commit

Permalink
Add spellcheck workflow and config
Browse files Browse the repository at this point in the history
  • Loading branch information
dbarbuzzi committed Jul 24, 2024
1 parent daa8fd8 commit c79d1d3
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/config/custom-wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
CUDA
neuralmagic
Neuralmagic
Neuralmagic's
nm
OpenAI
pre
premade
PyPI
vllm
vLLM
17 changes: 17 additions & 0 deletions .github/config/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
matrix:
- name: Markdown
pipeline:
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
aspell:
lang: en
d: en_US
mode: markdown
dictionary:
wordlists:
- .github/config/custom-wordlist.txt
sources:
- '**/*.md'
22 changes: 22 additions & 0 deletions .github/workflows/spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Spellcheck

on: push

jobs:

SPELLCHECK:
runs-on: ubuntu-latest
steps:

- uses: actions/checkout@v4

- name: Common misspellings check
uses: codespell-project/actions-codespell@v2

- name: Check spelling
uses: rojopolis/spellcheck-github-actions@v0
if: '!cancelled()'
with:
config_path: .github/config/spellcheck.yml
source_files: README.md
task_name: Markdown
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
venv

0 comments on commit c79d1d3

Please sign in to comment.