docs(ci): validate docs build on PRs targeting master (#6351)

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

* ci: validate docs build on PRs targeting master

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

---------

Signed-off-by: ivan katliarchuk <ivan.katliarchuk@gmail.com>

Author: ivankatliarchuk

.github/workflows/docs.yaml

@@ -1,23 +1,52 @@
-name: Release Docs
+name: Docs
 
 on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yaml"
   # See https://docs.github.com/fr/webhooks/webhook-events-and-payloads#workflow_dispatch
   # Can be used to update doc with latest tag
   workflow_dispatch:
-    tag:
-      description: "Build documentation for specified tag value"
-      required: true
-      type: string
+    inputs:
+      tag:
+        description: "Build documentation for specified tag value"
+        required: true
+        type: string
 
 permissions: {}
 
 jobs:
+  build_docs:
+    name: Lint Docs
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
+        with:
+          python-version: "3.12"
+          cache: "pip"
+          cache-dependency-path: "./docs/scripts/requirements.txt"
+
+      - run: pip install -r docs/scripts/requirements.txt
+
+      - name: lint and build docs
+        run: mkdocs build --strict
+
   release_docs:
     permissions:
       contents: write  #  for mike to push
 
     name: Release Docs
     runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch'
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
@@ -29,8 +58,7 @@ jobs:
           cache: "pip"
           cache-dependency-path: "./docs/scripts/requirements.txt"
 
-      - run: |
-          pip install -r docs/scripts/requirements.txt
+      - run: pip install -r docs/scripts/requirements.txt
 
       - name: Configure Git user
         run: |
@@ -39,6 +67,6 @@ jobs:
 
       - name: build and push
         run: |
-          VERSION="${{ input.tag }}"
+          VERSION="${{ inputs.tag }}"
           mike deploy $VERSION --push --update-aliases
           mike set-default --push latest

docs/contributing/dev-guide.md

@@ -27,7 +27,7 @@ Building and/or testing `external-dns` requires additional tooling.
 
 ### Go Tools
 
-Additional Go-based tools are managed in [`go.tool.mod`](../../go.tool.mod) and used for code generation:
+Additional Go-based tools are managed in `go.tool.mod` and used for code generation:
 
 | Tool                                                                  | Purpose                                            |
 |-----------------------------------------------------------------------|----------------------------------------------------|

mkdocs.yml

@@ -40,6 +40,7 @@ nav:
       - Rate Limits: docs/advanced/rate-limits.md
       - TTL: docs/advanced/ttl.md
       - Decisions: docs/proposal/0*.md
+      - Decision Template: docs/proposal/design-template.md
       - Domain Filter: docs/advanced/domain-filter.md
       - Configuration Precedence: docs/advanced/configuration-precedence.md
       - Split Horizon DNS: docs/advanced/split-horizon.md