Skip to content

Commit 66e4a3d

Browse files
authored
Create spellcheck.yml
Added auto spell check alert to all PRs created to documentation repo
1 parent 3d7a6e1 commit 66e4a3d

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

.github/workflows/spellcheck.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: "Spellcheck (Report Only)"
2+
3+
# Run on pushes and PRs against user-guides-pub
4+
on:
5+
push:
6+
branches: [ user-guides-pub ]
7+
pull_request:
8+
branches: [ user-guides-pub ]
9+
10+
jobs:
11+
codespell-check:
12+
name: Run Codespell (just notify)
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
# 1) Checkout the repository
17+
- name: Checkout code
18+
uses: actions/checkout@v3
19+
20+
# 2) Set up Python 3.x
21+
- name: Setup Python
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: "3.x"
25+
26+
# 3) Install Codespell
27+
- name: Install Codespell
28+
run: |
29+
python3 -m pip install --upgrade pip
30+
pip3 install codespell
31+
32+
# 4) Run Codespell in “report-only” mode
33+
- name: Run Codespell (no auto-fix)
34+
run: |
35+
codespell \
36+
--check-filenames \
37+
--skip="*.png,*.jpg,*.exe" \
38+
--ignore-words=hotwax-dictionary.txt \
39+
.

0 commit comments

Comments
 (0)