From: Michal Nowak <mnowak@isc.org>
Date: Fri, 24 Jan 2025 10:50:49 +0000 (+0100)
Subject: Add linkcheck job
X-Git-Tag: v9.18.34~17^2~1
X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=789cafb209d83ea7c9001077ddc12b9a3b543e35;p=thirdparty%2Fbind9.git

Add linkcheck job

(cherry picked from commit 48eab764273fe2e2b47ebbf08b6120d74ff11b81)
---

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index a11e4667712..dc79c623a11 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -679,6 +679,18 @@ changelog:
   artifacts:
     untracked: true
 
+linkcheck:
+  <<: *base_image
+  stage: docs
+  script:
+    - pushd doc/arm/ > /dev/null && sphinx-build -b linkcheck . linkcheck_output/
+  artifacts:
+    paths:
+      - doc/arm/linkcheck_output/
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "schedule"'
+  needs: []
+
 docs:
   <<: *default_triggering_rules
   <<: *base_image
diff --git a/doc/arm/conf.py b/doc/arm/conf.py
index 2c5a388c29b..8ef9a56b831 100644
--- a/doc/arm/conf.py
+++ b/doc/arm/conf.py
@@ -214,6 +214,20 @@ latex_documents = [
 
 latex_logo = "isc-logo.pdf"
 
+# -- Options for linkcheck ----------------------------------------------
+linkcheck_timeout = 10
+linkcheck_ignore = [
+    "http://127.0.0.1",
+    "https://gitlab.isc.org",
+    "https://kb.isc.org",
+    "https://simpleicon.com/",
+    "https://www.dnssec-or-not.com/",
+    "https://www.flaticon.com/",
+    "https://www.freepik.com/",
+    "https://www.godaddy.com",
+    "https://www.icann.org",
+]
+
 #
 # The rst_epilog will be completely overwritten from the Makefile,
 # the definition here is provided purely for situations when