feat: add link check (apache#635)

Signed-off-by: Ling Samuel <[email protected]>

.github/workflows/lint-checker.yml

@@ -91,3 +91,23 @@ jobs:
           node-version: '12.x'
       - run: npm install -g [email protected]
       - run: markdownlint '**/*.md' --ignore node_modules --ignore CHANGELOG.md
+  markdown-link-check:
+    needs: changes
+    if: |
+      (needs.changes.outputs.docs == 'true')
+    runs-on: ubuntu-latest
+    name: Check Markdown links
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - uses: ./.github/actions/markdown-link-check
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          config-file: 'link-check-config.json'
+          folder-path: 'docs/en'
+          file-path: './README.md, ./install.md, ./test/e2e/README.md'
+          max-depth: -1
+          file-extension: ".md"
+          check-modified-files-only: "no"

.gitmodules

@@ -19,3 +19,6 @@
 [submodule ".github/actions/paths-filter"]
 	path = .github/actions/paths-filter
 	url = https://github.com/dorny/paths-filter.git
+[submodule ".github/actions/markdown-link-check"]
+	path = .github/actions/markdown-link-check
+	url = https://github.com/gaurav-nelson/github-action-markdown-link-check.git

README.md

@@ -23,7 +23,8 @@
 
 Use [Apache APISIX](https://github.com/apache/apisix#apache-apisix) for Kubernetes [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/).
 
-All configurations in `apisix-ingress-controller` are defined with Kubernetes CRDs (Custom Resource Definitions). Such as configure [plugins](https://github.com/apache/apisix/blob/master/docs/en/latest/plugins.md), Support service registration discovery mechanism for upstreams, load balancing and more in Apache APISIX.
+All configurations in `apisix-ingress-controller` are defined with Kubernetes CRDs (Custom Resource Definitions).
+Support configuring [plugins](https://github.com/apache/apisix/blob/master/docs/en/latest/plugins), service registration discovery mechanism for upstreams, load balancing and more in Apache APISIX.
 
 `apisix-ingress-controller` is an Apache APISIX control plane component. Currently it serves for Kubernetes clusters. In the future, we plan to separate the submodule to adapt to more deployment modes, such as virtual machine clusters.
 
@@ -64,7 +65,7 @@ From the version 1.0.0, APISIX-ingress-controller need to work with Apache APISI
 ## Apache APISIX Ingress vs. Kubernetes Ingress Nginx
 
 * Hot-reload during yaml apply.
-* [More convenient canary deployment.](./docs/assets/en/latest/concepts/apisix_route.md)
+* [More convenient canary deployment.](./docs/en/latest/concepts/apisix_route.md)
 * Verify the correctness of the configuration, safe and reliable.
 * [Rich plugins and ecology.](https://github.com/apache/apisix/tree/master/docs/en/latest/plugins)
 * Supports APISIX custom resources and Kubernetes native Ingress resources.

link-check-config.json

@@ -0,0 +1,32 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://github.com/.*?/issue"
+    },
+    {
+      "pattern": "^https://github.com/.*?/pull"
+    },
+    {
+      "pattern": "^#"
+    }
+  ],
+  "replacementPatterns": [
+    {
+      "pattern": "^https://github.com/apache/apisix-ingress-controller/blob/master/",
+      "replacement": "{{BASEURL}}/"
+    },
+    {
+      "pattern": "^https://github.com/apache/apisix-ingress-controller/tree/master/",
+      "replacement": "{{BASEURL}}/"
+    },
+    {
+      "pattern": "^https://apisix.apache.org/docs/ingress-controller/(.*?)$",
+      "replacement": "{{BASEURL}}/docs/en/latest/$1.md"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": true,
+  "retryCount": 5,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [200, 206]
+}