mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-27 06:59:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
e14daeb8a4
curl/.github/workflows/spellcheck.yml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

51 lines
1.4 KiB
YAML
Raw Normal View History

copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205
2023-01-02 20:51:48 +08:00
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
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
2022-09-21 05:30:02 +08:00
#
# SPDX-License-Identifier: curl
name: spell
on:
push:
branches:
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- master
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
2022-09-21 05:30:02 +08:00
paths:
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- '**.md'
- '**/spellcheck.yml'
- '**/spellcheck.yaml'
spellcheck.yml: remove .1/.3 handling, clean all man page .md files Since we generate all .1 and .3 files from markdown now, we can limit the spellcheck to the markdown versions only. Closes #12960
2024-02-19 16:54:21 +08:00
- '.github/scripts/*'
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
2022-09-21 05:30:02 +08:00
pull_request:
branches:
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- master
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
2022-09-21 05:30:02 +08:00
paths:
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- '**.md'
- '**/spellcheck.yml'
- '**/spellcheck.yaml'
spellcheck.yml: remove .1/.3 handling, clean all man page .md files Since we generate all .1 and .3 files from markdown now, we can limit the spellcheck to the markdown versions only. Closes #12960
2024-02-19 16:54:21 +08:00
- '.github/scripts/*'
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
2022-09-21 05:30:02 +08:00
GHA: clarify workflows permissions, set least possible privilege Set top-level permissions to None on all workflows, setting per-job permissions. This avoids that new jobs inherit unwanted permissions. Discussion: https://curl.se/mail/lib-2022-11/0028.html Signed-off-by: Diogo Teles Sant'Anna <diogoteles@google.com> Closes #9928
2022-11-16 22:55:33 +08:00
permissions: {}
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
2022-09-21 05:30:02 +08:00
jobs:
check:
runs-on: ubuntu-latest
steps:
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- uses: actions/checkout@v4
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
2022-09-21 05:30:02 +08:00
spellcheck.yml: remove .1/.3 handling, clean all man page .md files Since we generate all .1 and .3 files from markdown now, we can limit the spellcheck to the markdown versions only. Closes #12960
2024-02-19 16:54:21 +08:00
- name: trim all man page *.md files
run: find docs -name "*.md" ! -name "_*" | xargs -n1 ./.github/scripts/cleancmd.pl
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
2022-09-21 05:30:02 +08:00
spellcheck.yml: remove .1/.3 handling, clean all man page .md files Since we generate all .1 and .3 files from markdown now, we can limit the spellcheck to the markdown versions only. Closes #12960
2024-02-19 16:54:21 +08:00
- name: trim libcurl man page *.md files
run: find docs/libcurl -name "curl_*.md" -o -name "libcurl*.md" | xargs -n1 ./.github/scripts/cleanspell.pl
CI/spellcheck: build curl.1 and spellcheck it Added acceptable words Closes #11562
2023-08-01 20:11:50 +08:00
spellcheck.yml: remove .1/.3 handling, clean all man page .md files Since we generate all .1 and .3 files from markdown now, we can limit the spellcheck to the markdown versions only. Closes #12960
2024-02-19 16:54:21 +08:00
- name: trim libcurl option man page *.md files
run: find docs/libcurl/opts -name "CURL*.md" | xargs -n1 ./.github/scripts/cleanspell.pl
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
2022-09-21 05:30:02 +08:00
spellcheck.yml: remove .1/.3 handling, clean all man page .md files Since we generate all .1 and .3 files from markdown now, we can limit the spellcheck to the markdown versions only. Closes #12960
2024-02-19 16:54:21 +08:00
- name: trim cmdline docs markdown _*.md files
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751
2024-01-21 06:18:43 +08:00
run: find docs/cmdline-opts -name "_*.md" | xargs -n1 ./.github/scripts/cleancmd.pl --no-header
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- name: setup the custom wordlist
run: grep -v '^#' .github/scripts/spellcheck.words > wordlist.txt
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
2022-09-21 05:30:02 +08:00
tidy-up: fix yamllint whitespace issues Closes #12466
2023-12-06 18:05:20 +08:00
- name: Check Spelling
uses: rojopolis/spellcheck-github-actions@v0
with:
config_path: .github/scripts/spellcheck.yaml
Reference in New Issue Copy Permalink