name: Check for bad links in documentation

on:
  pull_request:
    paths:
    # Only run on changes to .md files -- this check is too flakey to run on every PR
    - '**.md'
  workflow_dispatch: # Manual
  schedule:
  - cron: '0 6 * * *' # Nightly 6AM UTC
    
permissions:
  contents: read

jobs:
  markdown-link-check:
    permissions: 
      contents: read # to read files to check dead links 
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # master
    - uses: gaurav-nelson/github-action-markdown-link-check@58f84fd654812d0d8da4e4d4a559eda087daf8ce # v1.0.13
      with:
        use-quiet-mode: 'yes'
        config-file: .github/workflows/markdown-link-check-config.json
        base-branch: ${{ github.base_ref }}