lint-markdown.yml

name: Lint Markdown files

on:
  push:
    branches: ["main"]
    paths:
      - "*.md"
      - ".github/workflows/lint-markdown.yml"
  pull_request:
    branches: ["main"]
    paths:
      - "*.md"
      - ".github/workflows/lint-markdown.yml"
  schedule:
    - cron: "12 9 * * 4"
  workflow_dispatch:

jobs:
  lint:
    name: Lint Markdown
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Lint Markdown
        uses: DavidAnson/markdownlint-cli2-action@v16
        with:
          globs: "**/*.md"

  check-links:
    name: Check Dead Links
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Check Dead Link
        uses: umbrelladocs/action-linkspector@v1
        with:
          # Use github-pr-review when triggered by a pull request; otherwise, use github-check
          reporter: ${{ github.event_name == 'pull_request' && 'github-pr-review' || 'github-check' }}
          # Check all files in the repository for schedule; otherwise, check only changed files
          # filter_mode: ${{ github.event_name == 'schedule' && 'nofilter' || 'diff_context'}}
          filter_mode: nofilter