coder/.github/workflows/weekly-docs.yaml

name: weekly-docs
# runs every monday at 9 am
on:
  schedule:
    - cron: "0 9 * * 1"
  workflow_dispatch: # allows to run manually for testing
  pull_request:
    branches:
      - main
    paths:
      - "docs/**"

permissions:
  contents: read

jobs:
  check-docs:
    # later versions of Ubuntu have disabled unprivileged user namespaces, which are required by the action
    runs-on: ubuntu-22.04
    permissions:
      pull-requests: write # required to post PR review comments by the action
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9 # v2.14.1
        with:
          egress-policy: audit

      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Check Markdown links
        uses: umbrelladocs/action-linkspector@652f85bc57bb1e7d4327260decc10aa68f7694c3 # v1.4.0
        id: markdown-link-check
        # checks all markdown files from /docs including all subfolders
        with:
          reporter: github-pr-review
          config_file: ".github/.linkspector.yml"
          fail_on_error: "true"
          filter_mode: "file"

      - name: Send Slack notification
        if: failure() && github.event_name == 'schedule'
        run: |
          curl \
            -X POST \
            -H 'Content-type: application/json' \
            -d '{"msg":"Broken links found in the documentation. Please check the logs at '"${LOGS_URL}"'"}' "${{ secrets.DOCS_LINK_SLACK_WEBHOOK }}"
          echo "Sent Slack notification"
        env:
          LOGS_URL: https://github.com/coder/coder/actions/runs/${{ github.run_id }}