Skip to content

Commit 1332ec2

Browse files
authored
Add codespell support (config, workflow to detect/not fix) without fixes (#2117)
* Add github action to codespell main on push and PRs * Add rudimentary codespell config * ignores
1 parent 2cd0161 commit 1332ec2

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

.codespellrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[codespell]
2+
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
3+
skip = .git*,go.sum,.codespellrc
4+
check-hidden = true
5+
# ignore-regex =
6+
ignore-words-list = dne,haa

.github/workflows/codespell.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Codespell configuration is within .codespellrc
2+
---
3+
name: Codespell
4+
5+
on:
6+
push:
7+
branches: [main]
8+
pull_request:
9+
branches: [main]
10+
11+
permissions:
12+
contents: read
13+
14+
jobs:
15+
codespell:
16+
name: Check for spelling errors
17+
runs-on: ubuntu-latest
18+
19+
steps:
20+
- name: Checkout
21+
uses: actions/checkout@v4
22+
- name: Annotate locations with typos
23+
uses: codespell-project/codespell-problem-matcher@v1
24+
- name: Codespell
25+
uses: codespell-project/actions-codespell@v2

0 commit comments

Comments
 (0)