openstack-charm-guide-docs-links.yaml

name: docs links on docs.openstack.org/charm-guide/latest/

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:\/\/docs.openstack.org\/charm-guide\/latest\/
          checkextern=1
          ignore=
            http://localhost:8001\*
            https://groups\.openstack\.org
            https://openstack\.org/projects
            https://openstack\.org/projects\/openstack-faq
            ^.*\.css
            ^.*\.js

          [output]
          status=0
          warnings=0
          EOF

      - name: Run linkchecker
        continue-on-error: true
        run: |
          linkchecker https://docs.openstack.org/charm-guide/latest/ > ~/.linkchecker/openstackcharmguidedocs-out.txt

      - name: Parse linkchecker output
        run: |
          scripts/parseDocsLinkcheckerOutput openstackcharmguidedocs-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