test-links.yml

name: Test Links

on:
  push:
    branches:
      - '**'
  pull_request:
    types: [opened, reopened, synchronize]

# Minimal permissions - only read access needed for checks
permissions:
  contents: read

jobs:
  test-links:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.13'

      - name: Install nbconvert
        run: |
          python -m pip install --upgrade pip
          pip install nbconvert

      - name: Convert all notebooks to Markdown
        run: |
          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
        id: lychee-check
        uses: lycheeverse/lychee-action@v2
        with:
          args: --verbose --no-progress --config brev/lychee.toml --exclude-file brev/.lycheeignore '.'
          fail: true

      - name: Save PR number and result
        if: always() && github.event_name == 'pull_request'
        run: |
          mkdir -p ./pr-comment-data
          echo '${{ github.event.pull_request.number }}' > ./pr-comment-data/pr_number
          echo '${{ steps.lychee-check.outcome }}' > ./pr-comment-data/outcome

      - name: Upload PR comment data
        if: always() && github.event_name == 'pull_request'
        uses: actions/upload-artifact@v4
        with:
          name: pr-comment-data
          path: pr-comment-data/
          retention-days: 1