lychee: Improve CI and add local run command

Signed-off-by: Freya Gustavsson <[email protected]>

Author: Venefilyn

.github/workflows/pages-build-deployment.yml

@@ -0,0 +1,52 @@
+name: pages-build-deployment
+on:
+  push:
+    branches: ["main"]
+  # TODO: Make better when we have added this to the verify-links workflow
+  # https://lychee.cli.rs/github_action_recipes/pull-requests/
+  pull_request:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+jobs:
+  build:
+    name: Build Jekyll page
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+      - name: Upload Jekyll site for lychee URL checker
+        uses: actions/upload-artifact@v4
+        with:
+          name: build
+          path: ./_site
+          if-no-files-found: error
+          retention-days: 7
+      - name: Upload artifact for GitHub pages
+        if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+        uses: actions/upload-pages-artifact@v4
+  deploy:
+    name: Deploy to GitHub pages
+    if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+  verify_links:
+    name: Verify website links still work
+    needs: build
+    uses: ./.github/workflows/verify-links.yml
+    permissions:
+      issues: write # required for peter-evans/create-issue-from-file
+    with:
+      create_issue: ${{ github.event_name != 'pull_request' }}

.github/workflows/verify-links.yml

@@ -1,22 +1,42 @@
 name: Verify links
 
 on:
-  push:
-    branches:
-      - main
-      - workflow/verify-links # TODO REMOVE
+  # push:
+  #   branches:
+  #     - main
+  #     - workflow/verify-links # TODO Remove before merging PR
   repository_dispatch:
   workflow_dispatch:
+  workflow_call:
+    inputs:
+      create_issue:
+        required: false
+        type: boolean
+        default: false
   schedule:
     - cron: "08 08 * * 1"
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  linkChecker:
+  link_checker:
     runs-on: ubuntu-latest
     permissions:
       issues: write # required for peter-evans/create-issue-from-file
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v5
+        with:
+          name: "build"
+          path: "prod"
+
+      - name: Checkout lychee toml file
+        uses: actions/checkout@v5
+        with:
+          path: repo
+          sparse-checkout: '.lychee.toml'
+          sparse-checkout-cone-mode: false
 
       - name: Restore lychee cache
         uses: actions/cache@v4
@@ -30,40 +50,31 @@ jobs:
         uses: lycheeverse/lychee-action@v2
         with:
           fail: false
-          # Exclude all private and local addresses in the check
-          # Also exclude domains that actively block GitHub to send requests
-          # Any Cockpit URLs it finds that have variables will be ignored too
           args: |
-            --max-concurrency 1
-            --retry-wait-time 60
-            --base .
-            --skip-missing
-            --exclude-all-private
-            --exclude '^https://linux.die.net'
-            --exclude 'file:///'
-            --exclude 'domain.tld'
-            --exclude '^.*\{\{'
-            --exclude 'https://bodhi.fedoraproject.org/updates/cockpit-*'
-            --cache
-            --cache-exclude-status 400..=599
-            --max-cache-age 1d
-            -v
+            --root-dir "${{github.workspace}}/prod"
+            --config "${{github.workspace}}/repo/.lychee.toml"
             .
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Find the last open report issue
-        if: steps.lychee.outputs.exit_code != 0
+        if: |
+          steps.lychee.outputs.exit_code != 0
+            && inputs.create_issue
         id: last-issue
         uses: micalevisk/last-issue-action@v2
         with:
           state: open
           labels: link-checker
 
       - name: Update or create issue report
-        if: steps.lychee.outputs.exit_code != 0 && steps.last-issue.outputs.has-found == 'true'
+        if: |
+          steps.lychee.outputs.exit_code != 0
+            && steps.last-issue.outputs.has-found == 'false'
+            && inputs.create_issue
         uses: peter-evans/create-issue-from-file@v5
         with:
-          title: Link Checker Report
+          title: Broken links detected in docs 🔗
           content-filepath: ./lychee/out.md
           issue-number: ${{ steps.last-issue.outputs.issue-number }}
+          token: ${{secrets.GITHUB_TOKEN}}
           labels: link-checker

.lychee.toml

@@ -0,0 +1,26 @@
+# Don't exceed max_concurrency = 1 until this is implemented
+# https://github.com/lycheeverse/lychee/issues/989
+max_concurrency = 1
+retry_wait_time = 60
+skip_missing = true
+exclude_all_private = true
+exclude = [
+  # '^https://linux.die.net',
+  # We have this as an example
+  "domain.tld",
+  # 'https://bodhi.fedoraproject.org/updates/cockpit-*',
+  # Not local but used with podman etc.
+  "0.0.0.0",
+  # Need to be authenticated with GitHub edits and fails with 404 instead of 403
+  '^https:\/\/github.com\/cockpit-project\/cockpit\/wiki\/.*\/_edit',
+  # If we are checking files this will fail as it would match stuff like:
+  # `file:///blog/authors#name`
+  'file:///.*#.*'
+]
+cache = true
+cache_exclude_status = "400..=599"
+max_cache_age = "1d"
+
+exclude_link_local = true
+exclude_loopback = true
+verbose = "debug"

Makefile

@@ -0,0 +1,5 @@
+
+lychee-container:
+	podman run --init -it -v .:/input:Z,ro lycheeverse/lychee --root-dir "/input/_site" --config "/input/.lychee.toml" /input/_site
+
+.PHONY: lychee-container