Skip to content

Commit 1bf5223

Browse files
chore(ci): add cspell spell check workflow for markdown files
Signed-off-by: rinadavidyuk826-sudo <rinadavidyuk826@gmail.com>
1 parent 86817ca commit 1bf5223

File tree

3 files changed

+101
-0
lines changed

3 files changed

+101
-0
lines changed

.cspell-repo-terms.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
AgentOS
2+
AgentMesh
3+
AgentGovernance
4+
CMVK
5+
IATP
6+
Moltbook
7+
OpenClaw
8+
OpenAI
9+
LangChain
10+
LangGraph
11+
LlamaIndex
12+
CrewAI
13+
Dify
14+
SemanticKernel
15+
Microsoft
16+
GitHub
17+
workflow
18+
workflows
19+
markdown
20+
spellcheck
21+
spellchecking

.cspell.json

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"version": "0.2",
3+
"language": "en",
4+
"useGitignore": true,
5+
"dictionaries": ["repo-terms"],
6+
"dictionaryDefinitions": [
7+
{
8+
"name": "repo-terms",
9+
"path": "./.cspell-repo-terms.txt",
10+
"addWords": true
11+
}
12+
],
13+
"words": [
14+
"GitHub",
15+
"Markdown",
16+
"README",
17+
"TypeScript",
18+
"JavaScript",
19+
"Python",
20+
"PyPI",
21+
"NuGet",
22+
"OpenSSF",
23+
"CodeQL",
24+
"CORS",
25+
"CSP",
26+
"CLI",
27+
"CI",
28+
"CD",
29+
"PR",
30+
"MCP",
31+
"A2A"
32+
],
33+
"ignorePaths": [
34+
"**/node_modules/**",
35+
"**/dist/**",
36+
"**/build/**",
37+
"**/.venv/**",
38+
"**/.git/**",
39+
"**/*.png",
40+
"**/*.svg",
41+
"**/*.json",
42+
"**/*.lock"
43+
]
44+
}

.github/workflows/spell-check.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Spell Check
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
paths:
7+
- "**/*.md"
8+
- ".cspell.json"
9+
- ".cspell-repo-terms.txt"
10+
- ".github/workflows/spell-check.yml"
11+
12+
permissions:
13+
contents: read
14+
pull-requests: read
15+
16+
jobs:
17+
spell-check:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
21+
with:
22+
fetch-depth: 0
23+
24+
- name: Get changed markdown files
25+
id: changed-markdown
26+
uses: tj-actions/changed-files@v46
27+
with:
28+
files: |
29+
**/*.md
30+
31+
- name: Install cspell
32+
run: npm install --global cspell@8
33+
34+
- name: Check spelling
35+
if: steps.changed-markdown.outputs.any_changed == 'true'
36+
run: cspell --config .cspell.json --no-progress ${{ steps.changed-markdown.outputs.all_changed_files }}

0 commit comments

Comments
 (0)