[apisix-ingress-controller] branch master updated: feat(CI): add a GitHub Action to lint the Markdown (#97)

[kv...@apache.org]

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

kvn pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git


The following commit(s) were added to refs/heads/master by this push:
     new 7be0167  feat(CI): add a GitHub Action to lint the Markdown (#97)
7be0167 is described below

commit 7be01673020432575c26dc43ed979dcbfb93357a
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Wed Dec 16 11:42:56 2020 +1000

    feat(CI): add a GitHub Action to lint the Markdown (#97)
    
    Add a `.markdownlint.yml` config file
---
 .github/workflows/lint-checker.yml | 11 +++++++++++
 .markdownlint.yml                  | 31 +++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/.github/workflows/lint-checker.yml b/.github/workflows/lint-checker.yml
index c03cc19..31d65ab 100644
--- a/.github/workflows/lint-checker.yml
+++ b/.github/workflows/lint-checker.yml
@@ -26,3 +26,14 @@ jobs:
               echo $diffs
               exit 1
           fi
+  markdownlint:
+    name: 🍇 Markdown
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: 🚀 Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: '12.x'
+      - run: npm install -g markdownlint-cli@0.25.0
+      - run: markdownlint '**/*.md' --ignore node_modules
diff --git a/.markdownlint.yml b/.markdownlint.yml
new file mode 100644
index 0000000..4a744e9
--- /dev/null
+++ b/.markdownlint.yml
@@ -0,0 +1,31 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# MD004/ul-style Unordered list style
+MD004: false
+
+# MD013 Line length
+MD013: false
+
+#MD029/ol-prefix Ordered list item prefix
+MD029: false
+
+# MD033 Inline HTML
+MD033: false
+
+# MD036/no-emphasis-as-heading/no-emphasis-as-header Emphasis used instead of a heading
+MD036: false