From: Daniel Stenberg <daniel@haxx.se>
Date: Mon, 19 Sep 2022 15:30:05 +0000 (+0200)
Subject: GHA: run proselint on markdown files
X-Git-Tag: curl-7_86_0~204
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6e0dbe84e29b6fb8ab5899a4f6bec90ddf06ead5;p=thirdparty%2Fcurl.git

GHA: run proselint on markdown files

Co-authored-by: Marc Hörsken

Closes #9520
---

diff --git a/.github/workflows/proselint.yml b/.github/workflows/proselint.yml
new file mode 100644
index 0000000000..3152a48d06
--- /dev/null
+++ b/.github/workflows/proselint.yml
@@ -0,0 +1,62 @@
+# Copyright (C) 2022 Daniel Stenberg, <daniel@haxx.se>, et al.
+#
+# SPDX-License-Identifier: curl
+
+name: proselint
+
+on:
+  push:
+    branches:
+    - master
+    - '*/ci'
+    paths:
+    - '.github/workflows/proselint.yml'
+    - '**.md'
+  pull_request:
+    branches:
+    - master
+    paths:
+    - '.github/workflows/proselint.yml'
+    - '**.md'
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: install prereqs
+      run: sudo apt-get install python3-proselint
+
+    # config file help: https://github.com/amperser/proselint/
+    - name: create proselint config
+      run: |
+        cat <<JSON > $HOME/.proselintrc
+        {
+          "checks": {
+            "typography.diacritical_marks": false,
+            "typography.symbols": false,
+            "annotations.misc": false
+          }
+        }
+        JSON
+
+    - name: check prose
+      run: a=`git ls-files '*.md' | grep -v docs/CHECKSRC.md` && proselint $a README
+
+    # This is for CHECKSRC and files with aggressive exclamation mark needs
+    - name: create second proselint config
+      run: |
+        cat <<JSON > $HOME/.proselintrc
+        {
+          "checks": {
+            "typography.diacritical_marks": false,
+            "typography.symbols": false,
+            "typography.exclamation": false,
+            "annotations.misc": false
+          }
+        }
+        JSON
+
+    - name: check special prose
+      run: a=docs/CHECKSRC.md && proselint $a