Skip to content

Commit 277b0e6

Browse files
committed
Make GitHub Actions enforce codespell-error clean code
Signed-off-by: Sebastian Pipping <[email protected]>
1 parent ca72742 commit 277b0e6

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

.github/workflows/codespell.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
#
2+
# Copyright (c) 2024 Sebastian Pipping <[email protected]>
3+
#
4+
# This program is free software; you can redistribute it and/or modify
5+
# it under the terms of the GNU General Public License as published by
6+
# the Free Software Foundation; either version 2 of the License, or (at
7+
# your option) any later version.
8+
#
9+
# This program is distributed in the hope that it will be useful, but
10+
# WITHOUT ANY WARRANTY; without even the implied warranty of
11+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12+
# General Public License for more details.
13+
#
14+
# You should have received a copy of the GNU General Public License
15+
# along with this program; if not, see
16+
# <http://www.gnu.org/licenses/>.
17+
#
18+
name: Enforce codespell-clean spelling
19+
20+
on:
21+
pull_request:
22+
push:
23+
schedule:
24+
- cron: '0 14 * * 5' # Every Friday 2pm
25+
workflow_dispatch:
26+
27+
# Drop permissions to minimum for security
28+
permissions:
29+
contents: read
30+
31+
jobs:
32+
codespell:
33+
name: Enforce codespell-clean spelling
34+
runs-on: ubuntu-24.04
35+
steps:
36+
- uses: actions/checkout@v4
37+
38+
- uses: codespell-project/actions-codespell@v2
39+
with:
40+
# "bu" is man page markup (file man/genhtml.1 and man/lcov.1)
41+
# "MIS" is an abbreviation code of "Missed" (file bin/genhtml)
42+
# "nd" is variable $nd (file bin/genhtml)
43+
# "numbrs" is a variable name related to "branches" (file tests/bin/mkinfo)
44+
# Words need to be (1) separated by a comma and (2) all lowercase!
45+
ignore_words_list: bu,mis,nd,numbrs

0 commit comments

Comments
 (0)