]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
GHA: switch off proselint
authorDaniel Stenberg <daniel@haxx.se>
Thu, 17 Oct 2024 06:33:04 +0000 (08:33 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Thu, 17 Oct 2024 11:36:42 +0000 (13:36 +0200)
Because we cannot disable the individual warnings we do not care about,
making this tool almost unusable for our purposes. See
https://github.com/amperser/proselint/issues/1367

Instead, make 'very' a banned word (as recently that has been what
proselint most commonly points out for us).

Closes #15314

.github/scripts/badwords.txt
.github/workflows/checkdocs.yml

index 5bab85fbe48905962f2e35d65398d13c4db58d76..0af80b1dc744f09efb1d39c1d1621195006f0fa8 100644 (file)
@@ -65,3 +65,4 @@ couldn't:could not
 64 bit\b=64-bit
 64-bits:64 bits or 64-bit
 32-bits:32 bits or 32-bit
+\bvery\b:rephrase using an alternative word
index 0d6ff551f4a1b8603b217437fc55d589fbf842ce..e249ac62de00696dd954534eded279554f98cf2d 100644 (file)
@@ -33,54 +33,55 @@ concurrency:
 permissions: {}
 
 jobs:
-  proselint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
-        name: checkout
-
-      - name: install prereqs
-        run: |
-          sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list
-          sudo apt-get install python3-proselint
-
-      # config file help: https://github.com/amperser/proselint/
-      - name: create proselint config
-        run: |
-          cat <<JSON > $HOME/.proselintrc.json
-          {
-            "checks": {
-              "typography.diacritical_marks": false,
-              "typography.symbols": false,
-              "annotations.misc": false,
-              "security.password": false
-            }
-          }
-          JSON
-
-      - name: trim headers off all *.md files
-        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|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.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/internals/CHECKSRC.md docs/libcurl/curl_mprintf.md docs/libcurl/opts/CURLOPT_INTERFACE.md docs/cmdline-opts/interface.md
+  #  proselint:
+  #    runs-on: ubuntu-latest
+  #    steps:
+  #      - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
+  #        name: checkout
+  #
+  #      - name: install prereqs
+  #        run: |
+  #          sudo rm -f /etc/apt/sources.list.d/microsoft-prod.list
+  #          sudo apt-get install python3-proselint
+  #
+  #      # config file help: https://github.com/amperser/proselint/
+  #      - name: create proselint config
+  #        run: |
+  #          cat <<JSON > $HOME/.proselintrc.json
+  #          {
+  #            "checks": {
+  #              "typography.diacritical_marks": false,
+  #              "typography.symbols": false,
+  #              "annotations.misc": false,
+  #              "security.password": false,
+  #              "misc.annotations": false
+  #            }
+  #          }
+  #          JSON
+  #
+  #      - name: trim headers off all *.md files
+  #        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|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.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/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: