Add markdown link check (#53)

* DBACLD-139987 - Put in place checker link * ignore some broken links * ignore broken links with localhost URL --------- Co-authored-by: Frederic Mercier <[email protected]>
DecisionsDev · Jun 28, 2024 · 75567bf · 75567bf
1 parent e03a307
commit 75567bf
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 3 deletions.
diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml
@@ -0,0 +1,25 @@
+name: Check Markdown links
+
+#on:
+#  push:
+#    branches:
+#      - master
+#  pull_request:
+#    branches: [master]
+on: push
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: technote-space/get-diff-action@v6
+        with:
+          PATTERNS: |
+            **/**.md
+
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'yes'
+          use-verbose-mode: 'yes'
+          config-file: '.md_check_config.json'
+
diff --git a/.md_check_config.json b/.md_check_config.json
@@ -0,0 +1,14 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^http://localhost"
+    }
+  ],
+  "replacementPatterns": [
+      {
+        "pattern": "^/LICENSE",
+        "replacement": "{{BASEURL}}/LICENSE"
+      }
+    ],
+    "timeout": "20s"
+  }
diff --git a/docker/dockerhub/full-description.md b/docker/dockerhub/full-description.md
@@ -49,18 +49,20 @@ You must accept the license before you launch the image. The license is availabl
 docker run -e LICENSE=accept  -p 8888:8888 -p 9999:9999 icr.io/cpopen/odm-k8s/odm-metering-service:9.0-amd64
 ```
 
-When the server is started, use the URL http://localhost:8888 or https://localhost:9999 to display a welcome page.
+When the server is started, use the URL http://localhost:8888 or https://localhost:9999 to display a welcome page. <!-- markdown-link-check-disable-line -->
 
 The metering service receives usage information from Operational Decision Manager and aggregates it.
 
 When the service is available, you can get a zip archive of the ILMT files by using the /backup REST API endpoint.
-In a browser, access the zip archive by using http://localhost:8888/backup or https://localhost:9999/backup
+In a browser, access the zip archive by using http://localhost:8888/backup or https://localhost:9999/backup <!-- markdown-link-check-disable-line -->
 or use the following curl command:
 
+<!-- markdown-link-check-disable -->
 ```console
 curl http://localhost:8888/backup -o backup.zip
 curl -k https://localhost:9999/backup -o backup.zip
 ```
+<!-- markdown-link-check-enable -->
 
 ## Storage
 

diff --git a/topics/dssetup.md b/topics/dssetup.md
@@ -15,7 +15,7 @@ Among the parameters listed in the res-setup task document, the following parame
 Parameter | Description
 :-: | :-:
 metering.api.key | This parameter is not used, but it is mandatory. Use an arbitrary value.
-metering.server.url | To be set to the URL where the metering service is run, for example, http://host.company.com:8888/odm-metering-service.
+metering.server.url | To be set to the URL where the metering service is run, for example, http://host.company.com:8888/odm-metering-service. <!-- markdown-link-check-disable-line -->
 metering.enable | To be set to true so that the metering components can run.
 metering.send.usages | To be set to true so that actual usages are sent to the metering service.
 metering.instance.identifier | If specified, it is used as a reference to identify a metering client instance within Operational Decision Manager. This information appears in the log of the metering service, so it is recommended to be customized.