[enhancement]: Automatically linkcheck in CI (canonical#4479)

Signed-off-by: Aviral Singh <itsaviral.2609@gmail.com> Fixes canonicalGH-4460
georgehyde-dot · Oct 3, 2023 · 3d629fc · 3d629fc
1 parent 6ed6b69
commit 3d629fc
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/.github/workflows/linkcheck.yml b/.github/workflows/linkcheck.yml
@@ -0,0 +1,43 @@
+name: linkcheck in CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+  workflow_dispatch:
+    inputs:
+      failOnError:
+        description: 'Fail job on link check error'
+        required: false
+        default: 'false'
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-22.04
+    continue-on-error:${{ github.event_name == 'workflow_dispatch' && github.event.inputs.failOnError == 'true' ? false : true }}
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3.0.0
+
+      - name: "Install Python 3.10"
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10.8'
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run Sphinx linkcheck
+        run: tox -e linkcheck | tee output.txt
+
+      - name: Check for broken links below threshold 6
+        run: |
+          broken_count=$(grep -c "broken" output.txt)
+          if [[ $broken_count -ge 3 ]]; then
+            echo "Too many broken links detected: $broken_count"
+            exit 1
+          else
+            echo "Number of broken links is below threshold: $broken_count"
+          fi
diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py
@@ -119,6 +119,20 @@
 autosectionlabel_prefix_document = True
 autosectionlabel_maxdepth = 2
 
+# Sphinx-linkcheck config
+linkcheck_ignore = [
+    r"http://\[fd00:ec2::254.*",
+    r"http://instance-data.*",
+    r"https://powersj.io.*",
+    r"http://169.254.169.254.*",
+    r"http://10.10.0.1.*",
+]
+
+linkcheck_anchors_ignore_for_url = (
+    r"https://github.com/canonical/cloud-init.*",
+    r"https://github.com/canonical/ubuntu-pro-client.*",
+)
+
 # Sphinx-copybutton config options:
 notfound_body = (
     "<h1>Page not found</h1><p>Sorry we missed you! Our docs have had a"

diff --git a/tools/.github-cla-signers b/tools/.github-cla-signers
@@ -63,6 +63,7 @@ impl
 Indrranil
 irishgordo
 ITJamie
+itsaviral2609
 ixjhuang
 izzyleung
 j5awry