check-links.yml

name: Check hyperlinks

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: "3.10"

      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install "mistune<3.1"  # a newer version is incompatible with nbconvert
          pip install pytest pytest-check-links

      - name: Check links
        run: |
          pytest --check-links README.md --check-links-ignore "http*"
          pytest --check-links tutorials --check-links-ignore "http*"