xref: /curl/.github/workflows/spellcheck.yml (revision 7398037a) 
1# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
2#
3# SPDX-License-Identifier: curl
4
5name: spell
6on:
7  push:
8    branches:
9      - master
10    paths:
11      - '**.md'
12      - '**/spellcheck.yml'
13      - '**/spellcheck.yaml'
14      - '.github/scripts/*'
15  pull_request:
16    branches:
17      - master
18    paths:
19      - '**.md'
20      - '**/spellcheck.yml'
21      - '**/spellcheck.yaml'
22      - '.github/scripts/*'
23
24permissions: {}
25
26jobs:
27  check:
28    runs-on: ubuntu-latest
29    steps:
30      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4
31
32      - name: trim all man page *.md files
33        run: find docs -name "*.md" ! -name "_*" | xargs -n1 ./.github/scripts/cleancmd.pl
34
35      - name: trim libcurl man page *.md files
36        run: find docs/libcurl -name "curl_*.md" -o -name "libcurl*.md" | xargs -n1 ./.github/scripts/cleanspell.pl
37
38      - name: trim libcurl option man page *.md files
39        run: find docs/libcurl/opts -name "CURL*.md" | xargs -n1 ./.github/scripts/cleanspell.pl
40
41      - name: trim cmdline docs markdown _*.md files
42        run: find docs/cmdline-opts -name "_*.md" | xargs -n1 ./.github/scripts/cleancmd.pl --no-header
43
44      - name: setup the custom wordlist
45        run: grep -v '^#' .github/scripts/spellcheck.words >  wordlist.txt
46
47      - name: Check Spelling
48        uses: rojopolis/spellcheck-github-actions@dbd2f1da869c05ad874fffeb6fe1ed50cd1a6e98 # v0
49        with:
50          config_path: .github/scripts/spellcheck.yaml
51