From cdbcf7235c6b3ce3ca223a2dcc87cc9dec1eca43 Mon Sep 17 00:00:00 2001
From: Christophe Loiseau <christophe.loiseau@sovity.de>
Date: Fri, 17 May 2024 12:41:45 +0200
Subject: [PATCH] ci: speed-up documenation PRs (#926)

---
 .github/ISSUE_TEMPLATE/release.md |  1 +
 .github/workflows/check_docs.yml  | 24 ++++++++++++++++++++++++
 .github/workflows/ci.yml          | 18 +++++-------------
 3 files changed, 30 insertions(+), 13 deletions(-)
 create mode 100644 .github/workflows/check_docs.yml

diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md
index 6ff21b07a..0dc38085d 100644
--- a/.github/ISSUE_TEMPLATE/release.md
+++ b/.github/ISSUE_TEMPLATE/release.md
@@ -51,6 +51,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
   - [ ] If the Eclipse EDC version changed, update
         the [eclipse-edc-management-api.yaml file](https://github.com/sovity/edc-extensions/blob/main/docs/api/eclipse-edc-management-api.yaml).
   - [ ] Update the Postman Collection if required.
+  - [ ] Run all tests locally as long as the [GH flaky tests](https://github.com/sovity/edc-extensions/issues/870) are a problem.
   - [ ] Merge the `release-prep` PR.
 - [ ] Wait for the main branch to be green. You can check the status in GH [actions](https://github.com/sovity/edc-extensions/actions).
 - [ ] Validate the image
diff --git a/.github/workflows/check_docs.yml b/.github/workflows/check_docs.yml
new file mode 100644
index 000000000..b16f1266e
--- /dev/null
+++ b/.github/workflows/check_docs.yml
@@ -0,0 +1,24 @@
+name: Documentation Checks
+
+on:
+  push:
+    branches: [ main ]
+  release:
+    types: [ published ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  markdown-link-checks:
+    name: Markdown Link Checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: FranzDiebold/github-env-vars-action@v2
+      - uses: actions/checkout@master
+      - name: "Markdown Link Checker: Generate Config"
+        run: .github/markdown-link-checker-config.jq > .github/markdown-link-checker-config.json
+      - name: "Markdown Link Checker: Validate Links"
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'yes'
+          config-file: '.github/markdown-link-checker-config.json'
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index b6215677c..fe921bdb0 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -7,6 +7,11 @@ on:
     types: [ published ]
   pull_request:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
+      - '**.png'
+      - 'docs/api/**'
+      - 'LICENSE'
 
 env:
   REGISTRY_URL: ghcr.io
@@ -153,16 +158,3 @@ jobs:
         env:
           NODE_USER: richardtreier-sovity
           NODE_AUTH_TOKEN: ${{ secrets.SOVITY_EDC_CLIENT_NPM_AUTH }}
-  markdown-link-checks:
-    name: Markdown Link Checks
-    runs-on: ubuntu-latest
-    steps:
-      - uses: FranzDiebold/github-env-vars-action@v2
-      - uses: actions/checkout@master
-      - name: "Markdown Link Checker: Generate Config"
-        run: .github/markdown-link-checker-config.jq > .github/markdown-link-checker-config.json
-      - name: "Markdown Link Checker: Validate Links"
-        uses: gaurav-nelson/github-action-markdown-link-check@v1
-        with:
-          use-quiet-mode: 'yes'
-          config-file: '.github/markdown-link-checker-config.json'