links.yml

name: Check URLs with Lychee

on:
  push:
    branches:
      - main
  pull_request:
  schedule:
    - cron: "0 3 * * *"

jobs:
  Check-URLs:
    runs-on: ubuntu-latest
    steps:

      - name: Restore Lychee cache
        uses: actions/cache@v4
        with:
          path: .lycheecache
          key: cache-lychee-${{ github.sha }}
          restore-keys: cache-lychee-

      - uses: actions/checkout@v4

      - name: Link checker
        id: lychee
        uses: lycheeverse/lychee-action@f796c8b7d468feb9b8c0a46da3fac0af6874d374
        with:
          # Same as those in the PyBaMM repository
          args: |
            --cache
            --max-cache-age 3d .
            --verbose
            --no-progress
            --timeout 10
            --max-retries 5
            --skip-missing
            --exclude-loopback
            --exclude https://twitter.com/*
            --exclude "https://doi\.org|www.sciencedirect\.com/*"
            --exclude https://plausible.io/pybamm.org
            --accept 200,429,999
          format: markdown
          jobSummary: true
          fail: true
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

      # TBD: automatically open an issue if any links fail