broken-link-check.yml

name: "Broken Link Check"

on:
  push:
  schedule:
    - cron: 0 0 * * 0 # run every Sunday at midnight

jobs:
  check:
    name: "Check for broken links"
    runs-on: ubuntu-latest
    steps:
      - name: "Checkout code"
        uses: actions/checkout@v2
      - name: "Check for broken links"
        uses: lycheeverse/lychee-action@v1
        id: lychee
        with:
          fail: true
          jobSummary: true
          args: --no-progress --accept '200..=299, 401, 405' .
        continue-on-error: true
      - name: "Send Slack alert if failing"
        if: env.lychee_exit_code != 0 # && github.ref == 'refs/heads/main'
        uses: slackapi/slack-github-action@v1.26.0
        env:
          SLACK_WEBHOOK_URL: "https://hooks.slack.com/triggers/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" # TODO: set as secret
        with:
          payload: |
            {
              "Output": "${{ steps.lychee.outputs }}"
            }