CI: Switch to Lychee for link validation.

Author: brycelelbach

.github/workflows/test-links.yml

@@ -4,99 +4,35 @@ on:
   push:
     branches:
       - '**'
-  workflow_dispatch:
-    inputs:
-      tutorial:
-        description: 'Tutorial name to test'
-        required: true
-        type: string
-      commit_sha:
-        description: 'Commit SHA to update status for'
-        required: false
-        type: string
 
 jobs:
-  discover-tutorials:
-    if: github.event_name == 'push'
-    runs-on: ubuntu-latest
-    outputs:
-      tutorials: ${{ steps.find-tutorials.outputs.tutorials }}
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Find tutorial directories
-        id: find-tutorials
-        run: |
-          tutorials=$(brev/discover-tutorials.bash | jq -R -s -c 'split("\n") | map(select(length > 0))')
-          echo "tutorials=${tutorials}" >> $GITHUB_OUTPUT
-          echo "Found tutorials: ${tutorials}"
-
   test-links:
-    needs: [discover-tutorials]
-    if: always() && !cancelled()
     runs-on: ubuntu-latest
-    permissions:
-      statuses: write
-    strategy:
-      matrix:
-        tutorial: ${{ github.event_name == 'push' && fromJson(needs.discover-tutorials.outputs.tutorials) || fromJson(format('["{0}"]', format('tutorials/{0}', inputs.tutorial))) }}
-      fail-fast: false
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Set tutorial name
-        id: set-tutorial
-        run: |
-          tutorial_name=$(basename ${{ matrix.tutorial }})
-          echo "tutorial_name=${tutorial_name}" >> $GITHUB_OUTPUT
-
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
-      - name: Install dependencies
+      - name: Install nbconvert
         run: |
           python -m pip install --upgrade pip
-          pip install requests
-
-      - name: Test Markdown Links
-        id: test-markdown-links
-        run: |
-          python ./brev/test_markdown_links.py "${{ matrix.tutorial }}"
-
-      - name: Test Notebook Links
-        id: test-notebook-links
-        run: |
-          python ./brev/test_notebook_links.py "${{ matrix.tutorial }}"
-
-      - name: Update commit status to success
-        if: success() && (github.event_name == 'workflow_dispatch' && inputs.commit_sha != '')
-        run: |
-          gh api \
-            --method POST \
-            -H "Accept: application/vnd.github+json" \
-            /repos/${{ github.repository }}/statuses/${{ inputs.commit_sha }} \
-            -f state='success' \
-            -f target_url="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
-            -f description='Link tests passed' \
-            -f context='test-links / ${{ steps.set-tutorial.outputs.tutorial_name }}'
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          pip install nbconvert
 
-      - name: Update commit status to failure
-        if: failure() && (github.event_name == 'workflow_dispatch' && inputs.commit_sha != '')
+      - name: Convert all Notebooks to Markdown
         run: |
-          gh api \
-            --method POST \
-            -H "Accept: application/vnd.github+json" \
-            /repos/${{ github.repository }}/statuses/${{ inputs.commit_sha }} \
-            -f state='failure' \
-            -f target_url="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
-            -f description='Link tests failed' \
-            -f context='test-links / ${{ steps.set-tutorial.outputs.tutorial_name }}'
-        env:
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          echo "Converting all Jupyter notebooks to markdown..."
+          find . -name "*.ipynb" -type f | while read notebook; do
+            echo "Converting: $notebook"
+            jupyter nbconvert --to markdown "$notebook"
+          done
+
+      - name: Check Links with Lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: --verbose --no-progress '.'
+          fail: true

brev/link_validator.py

@@ -1,27 +1,53 @@
-#! /bin/bash
-
-# This script tests a single Docker Compose file by starting and stopping containers.
+#!/usr/bin/env bash
+#
+# Test a Docker Compose file by starting and stopping containers.
+#
+# This script validates Docker Compose configurations by attempting to start,
+# inspect, and cleanly stop containers.
 #
 # Usage:
-#   ./test-docker-compose.bash <tutorial-name|docker-compose-file>
+#   ./brev/test-docker-compose.bash <tutorial-name|docker-compose-file>
 #
 # Examples:
-#   ./test-docker-compose.bash accelerated-python
-#   ./test-docker-compose.bash tutorials/accelerated-python/brev/docker-compose.yml
+#   ./brev/test-docker-compose.bash accelerated-python
+#   ./brev/test-docker-compose.bash tutorials/accelerated-python/brev/docker-compose.yml
 
 set -euo pipefail
 
+# Colors for output
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
 SCRIPT_PATH=$(cd $(dirname ${0}); pwd -P)
 REPO_ROOT=$(cd ${SCRIPT_PATH}/..; pwd -P)
 
+# Print usage
+usage() {
+    cat << EOF
+Usage: $(basename "$0") <tutorial-name|docker-compose-file>
+
+Test a Docker Compose file by starting and stopping containers.
+
+Arguments:
+  tutorial-name          Name of tutorial (e.g., accelerated-python)
+  docker-compose-file    Path to docker-compose.yml file
+
+Examples:
+  $(basename "$0") accelerated-python
+  $(basename "$0") tutorials/accelerated-python/brev/docker-compose.yml
+
+Requirements:
+  - Docker and Docker Compose must be installed
+EOF
+    exit 1
+}
+
 # Check argument
 if [ $# -ne 1 ]; then
-    echo "Error: Tutorial name or Docker Compose file path is required"
-    echo "Usage: $0 <tutorial-name|docker-compose-file>"
-    echo "Examples:"
-    echo "  $0 accelerated-python"
-    echo "  $0 tutorials/accelerated-python/brev/docker-compose.yml"
-    exit 1
+    echo -e "${RED}Error: Tutorial name or Docker Compose file path is required${NC}"
+    usage
 fi
 
 ARG=$1
@@ -43,7 +69,7 @@ else
 
     # Check if tutorial directory exists
     if [ ! -d "${TUTORIAL_PATH}" ]; then
-        echo "❌ Error: Tutorial directory not found: ${TUTORIAL_PATH}"
+        echo -e "${RED}Error: Tutorial directory not found: ${TUTORIAL_PATH}${NC}"
         exit 1
     fi
 
@@ -52,21 +78,21 @@ fi
 
 # Validate docker-compose file exists
 if [ ! -f "${COMPOSE_FILE}" ]; then
-    echo "❌ Error: Docker Compose file not found: ${COMPOSE_FILE}"
+    echo -e "${RED}Error: Docker Compose file not found: ${COMPOSE_FILE}${NC}"
     exit 1
 fi
 
-echo "============================================"
+echo "================================================================================"
 echo "Testing Docker Compose: ${COMPOSE_FILE}"
-echo "============================================"
+echo "================================================================================"
 echo ""
 
 # Start containers
 echo "📦 Starting containers..."
 echo ""
 if docker compose -f "${COMPOSE_FILE}" up -d; then
     echo ""
-    echo "✅ Containers started successfully"
+    echo -e "${GREEN}✅ Containers started successfully${NC}"
     echo ""
 
     # Wait a moment for containers to initialize
@@ -81,32 +107,32 @@ if docker compose -f "${COMPOSE_FILE}" up -d; then
 
     # Capture and display logs
     echo "📋 Container logs:"
-    echo "--------------------------------------------"
+    echo "--------------------------------------------------------------------------------"
     docker compose -f "${COMPOSE_FILE}" logs
-    echo "--------------------------------------------"
+    echo "--------------------------------------------------------------------------------"
     echo ""
 
     # Stop containers
     echo "🛑 Stopping containers..."
     if docker compose -f "${COMPOSE_FILE}" down; then
-        echo "✅ Containers stopped successfully"
+        echo -e "${GREEN}✅ Containers stopped successfully${NC}"
         echo ""
         return_code=0
     else
-        echo "❌ Failed to stop containers"
+        echo -e "${RED}❌ Failed to stop containers${NC}"
         echo ""
         return_code=1
     fi
 else
     echo ""
-    echo "❌ Failed to start containers"
+    echo -e "${RED}❌ Failed to start containers${NC}"
     echo ""
 
     # Try to capture any logs that might be available
     echo "📋 Attempting to capture logs from failed startup:"
-    echo "--------------------------------------------"
+    echo "--------------------------------------------------------------------------------"
     docker compose -f "${COMPOSE_FILE}" logs || true
-    echo "--------------------------------------------"
+    echo "--------------------------------------------------------------------------------"
     echo ""
 
     # Try to clean up
@@ -117,13 +143,13 @@ else
     return_code=1
 fi
 
-echo "============================================"
+echo ""
+echo "================================================================================"
 if [ ${return_code} -eq 0 ]; then
-    echo "✅ TEST PASSED: ${COMPOSE_FILE}"
+    echo -e "${GREEN}✅ TEST PASSED: ${COMPOSE_FILE}${NC}"
 else
-    echo "❌ TEST FAILED: ${COMPOSE_FILE}"
+    echo -e "${RED}❌ TEST FAILED: ${COMPOSE_FILE}${NC}"
 fi
-echo "============================================"
-echo ""
+echo "================================================================================"
 
 exit ${return_code}