(sedona) branch master updated: [SEDONA-442] pre-commit: add hook markdown-lint (#1141)

[ji...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git


The following commit(s) were added to refs/heads/master by this push:
     new 8cbe4f8e6 [SEDONA-442] pre-commit: add hook markdown-lint (#1141)
8cbe4f8e6 is described below

commit 8cbe4f8e69b8221ba1f1f03164955a4d44dac76d
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Wed Dec 13 10:59:50 2023 +1000

    [SEDONA-442] pre-commit: add hook markdown-lint (#1141)
---
 .github/linters/.markdown-lint.yml | 28 ++++++++++++++++++++++++++++
 .pre-commit-config.yaml            | 10 ++++++++++
 docs/setup/release-notes.md        |  2 +-
 3 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
new file mode 100644
index 000000000..c180f7800
--- /dev/null
+++ b/.github/linters/.markdown-lint.yml
@@ -0,0 +1,28 @@
+# https://github.com/DavidAnson/markdownlint#rules--aliases
+MD001: false
+MD004: false
+MD005: false
+MD007: false
+MD009: false
+MD010: false
+MD012: false
+MD013: false
+MD022: false
+MD024: false
+MD025: false
+MD026: false
+MD029: false
+MD030: false
+MD031: false
+MD032: false
+MD033: false
+MD034: false
+MD036: false
+MD037: false
+MD038: false
+MD040: false
+MD041: false
+MD042: false
+MD045: false
+MD046: false
+MD051: false
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index bcb284d39..5a61ea5d4 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -35,3 +35,13 @@ repos:
       - id: end-of-file-fixer
         files: \.(java|md|py|scala)$
         exclude: ^docs/image|^spark/common/src/test/resources
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.38.0
+    hooks:
+      - id: markdownlint
+        name: Run markdownlint
+        description: Check Markdown files with markdownlint
+        entry: markdownlint -c .github/linters/.markdown-lint.yml .
+        exclude: ^\.github/.*$
+        types: [markdown]
+        files: \.(md|mdown|markdown)$
diff --git a/docs/setup/release-notes.md b/docs/setup/release-notes.md
index a292593e6..acaa44486 100644
--- a/docs/setup/release-notes.md
+++ b/docs/setup/release-notes.md
@@ -76,7 +76,7 @@ Sedona 1.5.0 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.
 </li>
 </ul>
         
-###        New Feature
+### New Feature
 
 <ul>
 <li>[<a href='https://issues.apache.org/jira/browse/SEDONA-200'>SEDONA-200</a>] -         Add ST_CoordDim to Sedona