core-docs-links.yaml

name: docs links on ubuntu.com/core/docs

on:
  schedule:
    - cron: "0 13 * * *"
  workflow_dispatch:

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

    steps:
      - uses: actions/checkout@v4

      - name: Install linkchecker
        run: sudo pip install LinkChecker

      - name: Write linkchecker config file
        run: |
          mkdir -p ~/.linkchecker
          cat > ~/.linkchecker/linkcheckerrc <<EOF
          [checking]
          maxrequestspersecond=5

          [filtering]
          nofollow=!https:\/\/ubuntu.com\/core\/docs
          checkextern=1
          ignore=
            https://res\.cloudinary\.com
            /q_auto
            c_fill
            /fl_sanitize
            e_sharpen
            /w_
            /h_

          [output]
          status=0
          warnings=0
          EOF

      - name: Run linkchecker
        continue-on-error: true
        run: |
          linkchecker https://ubuntu.com/core/docs > ~/.linkchecker/coredocs-out.txt

      - name: Parse linkchecker output
        run: |
          scripts/parseDocsLinkcheckerOutput coredocs-out.txt

      - name: Send message on failure
        if: failure()
        run: |
          curl -X POST \
            -F "workflow=${GITHUB_WORKFLOW}" \
            -F "repo_name=${GITHUB_REPOSITORY}" \
            -F "action_id=${GITHUB_RUN_ID}" \
            ${{ secrets.BOT_URL }}?room=docs