]> git.ipfire.org Git - thirdparty/curl.git/commit
GHA: spellcheck
authorDaniel Stenberg <daniel@haxx.se>
Tue, 20 Sep 2022 21:30:02 +0000 (23:30 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 21 Sep 2022 13:20:07 +0000 (15:20 +0200)
commit72c41f7c8b3c55fc69950e1c6c37b91bd860d411
tree7e06e10ef425bfe682e2fc84b067864b9f3e3a7e
parent62672441610c850d0ab43e39684a7c37f5200bf0
GHA: spellcheck

This spellchecker checks markdown files. For this reason this job
converts all man pages in the repository to markdown with pandoc before
the check runs.

The perl script 'cleanspell' filters out details from the man page in
the process, to avoid the spellchecker trying to spellcheck things it
can't. Like curl specific symbols and the SYNOPSIS and EXAMPLE sections
of libcurl man pages.

The spell checker does not check words in sections that are within pre,
strong and em tags.

'spellcheck.words' is a custom word list with additional accepted words.

Closes #9523
.github/scripts/cleanspell.pl [new file with mode: 0755]
.github/scripts/spellcheck.words [new file with mode: 0644]
.github/scripts/spellcheck.yaml [new file with mode: 0644]
.github/workflows/spellcheck.yml [new file with mode: 0644]