Add broken link checker to deploy preview workflow

.github/workflows/broken-link-ci.yml

@@ -0,0 +1,31 @@
+name: Run Continuous Integration (link-checker)
+on:
+  pull_request:
+    paths: 'link-checker/**'
+
+jobs:
+  go-test:
+    permissions:
+      contents: read
+      # Allow write access to checks to allow the golangci-lint action to annotate code in the PR.
+      checks: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+        with:
+          persist-credentials: false
+          sparse-checkout: |
+            link-checker
+      - uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.6.0
+        with:
+          go-version-file: link-checker/go.mod
+      - uses: golangci/golangci-lint-action@1e7e51e771db61008b38414a730f564565cf7c20 # v9
+        with:
+          working-directory: link-checker
+      - run: go test ./...
+        working-directory: link-checker
+      - run: go build ./cmd/link-checker
+        working-directory: link-checker
+      - run: docker build --tag writers-toolkit-link-checker:test .
+        working-directory: link-checker
+      - run: docker run --rm writers-toolkit-link-checker:test help

.github/workflows/deploy-pr-preview.yml

@@ -13,7 +13,7 @@ on:
 
 jobs:
   deploy-pr-preview:
-    uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@main
+    uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@robbymilo/deploy-preview # zizmor: ignore[unpinned-uses] It's a protected branch in the same repository.
     if: "!github.event.pull_request.head.repo.fork"
     permissions:
       contents: read # Clone repository.

.gitignore

@@ -8,3 +8,12 @@ build.conf
 /dist
 /vale/Grafana.zip
 vale/tools/inhibit-rules
+access.log
+.gitignore
+changed-files.txt
+error.log
+links.json
+broken-links-comment.md
+nginx.conf
+run/nginx.pid
+docs/dist

deploy-preview/Dockerfile

@@ -6,6 +6,8 @@ RUN rm -rf /etc/nginx/sites-enabled && \
   rm -rf /etc/nginx/nginx.conf
 
 COPY deploy-preview-files/deploy-preview/nginx.conf /etc/nginx/nginx.conf
+COPY deploy-preview-files/deploy-preview/locations.conf /etc/nginx/locations.conf
+COPY deploy-preview-files/deploy-preview/redirects.conf /etc/nginx/redirects.conf
 COPY build.conf /etc/nginx/build.conf
 
-RUN nginx -t
+RUN nginx -t

deploy-preview/build

@@ -14,13 +14,15 @@ if [[ -n "${WEBSITE_DIRECTORY}" ]]; then
   readonly SOURCE_DIRECTORY="${SOURCE_DIRECTORY:-}"
   readonly REPO="${REPO:-}"
   readonly INDEX_FILE="${INDEX_FILE:-false}"
+  readonly RELATIVE_PREFIX="${RELATIVE_PREFIX:-/docs/${REPO}/latest/}"
 
   docker run \
          -v "${PWD}/dist:/hugo/dist" \
          -v "${PWD}/${SOURCE_DIRECTORY}:/hugo/${WEBSITE_DIRECTORY}" \
          -e INDEX_FILE \
          -e REPO \
          -e WEBSITE_DIRECTORY \
+         -e RELATIVE_PREFIX \
          --rm "${IMAGE:-grafana/docs-base:latest}" \
          /bin/bash \
          -c '
@@ -29,7 +31,7 @@ if [[ "${INDEX_FILE}" == "true" ]]; then
   cat > "/hugo/content/docs/${REPO}/_index.md" <<EOF
 ---
 type: redirect
-redirectURL: /docs/${REPO}/latest/
+redirectURL: ${RELATIVE_PREFIX}
 versioned: true
 ---
 EOF

deploy-preview/docs-target

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+# Determine the documentation target directory from a Git base ref.
+# Mirrors the logic from https://github.com/grafana/grafana-github-actions/tree/main/docs-target
+#
+# Usage: docs-target <base_ref>
+#
+# For main/master branches, the target is "next".
+# For release branches, the target is "latest".
+
+set -euf -o pipefail
+
+readonly BASE_REF="${1:-}"
+
+if [[ -z "${BASE_REF}" ]]; then
+  echo "Usage: docs-target <base_ref>" >&2
+  exit 1
+fi
+
+case "${BASE_REF}" in
+  main|master)
+    echo "next"
+    ;;
+  *)
+    echo "latest"
+    ;;
+esac

deploy-preview/locations.conf

@@ -0,0 +1,34 @@
+location /static {
+  proxy_pass https://grafana.com/static;
+}
+
+location /media {
+  proxy_pass https://grafana.com/media;
+}
+
+location /api {
+  proxy_pass https://grafana.com/api;
+}
+
+location ~ ^/(web|grafana|help|community|blog|products|oss|events|tutorials|whats-new|contact|login|auth|developers|profile|orgs|legal|tutorials|signup|pricing|enterprise|accessibility|assets|about|go|careers|press|support|security)(/.*)?$ {
+  proxy_pass https://grafana.com;
+}
+
+location ~ ^/connect(.*)$ {
+
+  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+  proxy_set_header Host $http_host;
+  proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
+
+  proxy_ssl_server_name on;
+  resolver          8.8.8.8 8.8.4.4 ipv6=off;
+  resolver_timeout  5s;
+  set $faro "faro-collector-prod-us-central-0.grafana.net";
+
+  proxy_pass https://$faro/collect$1;
+}
+
+location /healthz {
+  return 200 'ok';
+  add_header Content-Type text/plain;
+}

deploy-preview/nginx.conf

@@ -70,36 +70,7 @@ http {
       alias /usr/share/nginx/dist/;
     }
 
-    location /static {
-      proxy_pass https://grafana.com/static;
-    }
-
-    location /media {
-      proxy_pass https://grafana.com/media;
-    }
-
-    location /api {
-      proxy_pass https://grafana.com/api;
-    }
-
-    location ~ ^/connect(.*)$ {
-
-      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-      proxy_set_header Host $http_host;
-      proxy_set_header X-Forwarded-Proto $http_x_forwarded_proto;
-
-      proxy_ssl_server_name on;
-      resolver          8.8.8.8 8.8.4.4 ipv6=off;
-      resolver_timeout  5s;
-      set $faro "faro-collector-prod-us-central-0.grafana.net";
-
-      proxy_pass https://$faro/collect$1;
-    }
-
-
-    location /healthz {
-      return 200 'ok';
-      add_header Content-Type text/plain;
-    }
+    include /etc/nginx/locations.conf;
+    include /etc/nginx/redirects.conf;
   }
-}
+}