linkcheck.yml

name: Check markdown links

on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 1 * *' # Every month
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - '.lycheeignore'
      - '.github/workflows/linkcheck.yml'

env:
  DIR: 'docs'

jobs:
  linkcheck:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Julia
        uses: julia-actions/setup-julia@v2
      - name: Convert literate notebooks to ipynb files
        shell: julia --color=yes {0}
        run: |
          import Pkg
          Pkg.add("Literate")
          using Literate
          for (root, dirs, files) in walkdir("docs")
            for file in files
              if endswith(file, ".jl")
                nb = joinpath(root, file)
                Literate.notebook(nb, dirname(nb); mdstrings=true, execute=false)
              end
            end
          end
      - name: Setup Python
        uses: actions/setup-python@v5
        id: cp
        with:
          python-version: '3.x'
      - name: Cache pip dependencies
        uses: actions/cache@v4
        id: cache-py
        with:
          key:  ${{ runner.os }}-pip-${{ steps.cp.outputs.python-version }}-${{ hashFiles('requirements-jb.txt') }}
          path: |
            ${{ env.pythonLocation }}/lib
            ${{ env.pythonLocation }}/bin
      - name: Install pip dependencies if cache miss
        if: ${{ steps.cache-py.outputs.cache-hit != 'true' }}
        run: pip install -r requirements-jb.txt
      - name: Check links
        run: jb build ${DIR} --builder linkcheck