From c99d8be4e230235eb22336abe521ce608e336ae1 Mon Sep 17 00:00:00 2001
From: deadc0de6 <info@deadc0de.ch>
Date: Thu, 27 Jun 2024 09:14:13 +0200
Subject: [PATCH] dedicated doc links workflow

---
 .github/workflows/test-doc.yml | 24 ++++++++++++++++++++++++
 .github/workflows/testing.yml  |  3 +--
 tests.sh                       |  7 +++++--
 3 files changed, 30 insertions(+), 4 deletions(-)
 create mode 100644 .github/workflows/test-doc.yml

diff --git a/.github/workflows/test-doc.yml b/.github/workflows/test-doc.yml
new file mode 100644
index 0000000..cc77d14
--- /dev/null
+++ b/.github/workflows/test-doc.yml
@@ -0,0 +1,24 @@
+name: test-doc
+on: [push, pull_request, workflow_dispatch]
+jobs:
+  test-doc:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.x'
+    - name: Setup Node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 16
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r tests-requirements.txt
+        npm install -g remark-cli remark-validate-links
+    - name: Run with 1 worker
+      run: |
+        ./scripts/check-doc.sh
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
index 489c960..e5f37ac 100644
--- a/.github/workflows/testing.yml
+++ b/.github/workflows/testing.yml
@@ -9,7 +9,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Setup Node
@@ -21,7 +21,6 @@ jobs:
         python -m pip install --upgrade pip
         pip install -r tests-requirements.txt
         pip install -r requirements.txt
-        npm install -g remark-cli remark-validate-links
         sudo apt-get install shellcheck
     - name: Run with 1 worker
       run: |
diff --git a/tests.sh b/tests.sh
index 0efd8c3..3a793f3 100755
--- a/tests.sh
+++ b/tests.sh
@@ -55,8 +55,11 @@ coverage combine coverages/*
 coverage xml
 
 # test doc
-echo "checking documentation..."
-"${cur}"/scripts/check-doc.sh
+if [ -z "${in_cicd}" ]; then
+  # not in CI/CD
+  echo "checking documentation..."
+  "${cur}"/scripts/check-doc.sh
+fi
 
 ## done
 echo "All tests finished successfully"