romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-07-26 02:37:16 +03:00
Code Issues Projects Releases Packages Wiki Activity

GHA: silence proselint warnings and an error

Browse source 
Fix new issues found by `proselint`.

Also:
- silence this technical warning:
  ```
  :0: DeprecationWarning: /home/runner/.proselintrc was found instead of a JSON file. Rename to /home/runner/.proselintrc.json.
  ```
- fix an input filename.
  `proselints` fails now if an input file is missing.

Reported-by: Jay Satiro
Bug: https://github.com/curl/curl/pull/15291#issuecomment-2410505100
Closes #15293
This commit is contained in:
Viktor Szakats 2024-10-14 11:27:54 +02:00
parent 8403e5a701
commit 3040971d12
No known key found for this signature in database
GPG key ID: B5ABD165E2AEF201
84 changed files with 95 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

9
.github/workflows/checkdocs.yml vendored
View file

@ -47,7 +47,7 @@ jobs:
# config file help: https://github.com/amperser/proselint/
- name: create proselint config
run: |
cat <<JSON > $HOME/.proselintrc
cat <<JSON > $HOME/.proselintrc.json
{
"checks": {
"typography.diacritical_marks": false,
@ -62,24 +62,25 @@ jobs:
run: git ls-files -z '*.md' | xargs -0 -n1 .github/scripts/trimmarkdownheader.pl
- name: check prose
run: git ls-files -z '*.md' | grep -Evz 'CHECKSRC.md|DISTROS.md|CURLOPT_INTERFACE.md|interface.md' | xargs -0 proselint README
run: git ls-files -z '*.md' | grep -Evz 'CHECKSRC.md|DISTROS.md|curl_mprintf.md|CURLOPT_INTERFACE.md|interface.md' | xargs -0 proselint README
# This is for CHECKSRC and files with aggressive exclamation mark needs
- name: create second proselint config
run: |
cat <<JSON > $HOME/.proselintrc
cat <<JSON > $HOME/.proselintrc.json
{
"checks": {
"typography.diacritical_marks": false,
"typography.symbols": false,
"typography.exclamation": false,
"lexical_illusions.misc": false,
"annotations.misc": false
}
}
JSON
- name: check special prose
run: proselint docs/CHECKSRC.md docs/libcurl/opts/CURLOPT_INTERFACE.md docs/cmdline-opts/interface.md
run: proselint docs/internals/CHECKSRC.md docs/libcurl/curl_mprintf.md docs/libcurl/opts/CURLOPT_INTERFACE.md docs/cmdline-opts/interface.md
# Docs: https://github.com/marketplace/actions/markdown-link-check
linkcheck: