check-links.yml

name: Check documentation links

on:
  push:
    paths:
      - ".github/workflows/check-links.yml"
      - "Taskfile.yml"
      - "**.md"
  pull_request:
    paths:
      - ".github/workflows/check-links.yml"
      - "Taskfile.yml"
      - "**.md"
  schedule:
    # Run every Tuesday at 03:00 UTC to catch broken links caused by external changes
    - cron: "0 3 * * 2"

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

    env:
      DOCUMENTATION_REQUIREMENTS_PATH: ./docs/requirements_docs.txt

    steps:
      - name: Checkout local repository
        uses: actions/checkout@v2

      - name: Install Taskfile
        uses: arduino/setup-task@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}
          version: 3.x

      - name: Install Go
        uses: actions/setup-go@v2
        with:
          go-version: "1.14"

      - name: Install Python
        uses: actions/setup-python@v2
        with:
          python-version: "3.8"

      - name: Cache dependencies
        uses: actions/cache@v2
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles(env.DOCUMENTATION_REQUIREMENTS_PATH) }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - name: Install Poetry
        run: |
          python -m pip install --upgrade pip
          python -m pip install poetry

      - name: Build documentation website
        # Ensure the documentation can build. These docs won't be published.
        run: task docs:build

      - name: Check links
        run: task --silent docs:check-links