markdown-lint.yml

name: Markdown Lint

on:
    push:
        branches: [main]
        paths:
            - '**/*.md'
            - '.markdownlint.json'
            - '.markdownlintignore'
            - '.github/workflows/markdown-lint.yml'
    pull_request:
        branches: [main]
        paths:
            - '**/*.md'
            - '.markdownlint.json'
            - '.markdownlintignore'
            - '.github/workflows/markdown-lint.yml'

jobs:
    lint-markdown:
        runs-on: ubuntu-latest

        steps:
            - name: Checkout repository
              uses: actions/checkout@v4
            - name: Use Node.js ${{ matrix.node-version }}
              uses: actions/setup-node@v4
              with:
                  node-version: ${{ matrix.node-version }}
            - name: Cache Node.js modules
              uses: actions/cache@v4
              with:
                  path: ~/.npm
                  key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
                  restore-keys: |
                      ${{ runner.os }}-node-
            - name: Run installs
              run: npm ci --legacy-peer-deps
            - name: Run markdownlint on Markdown files
              run: npm run lint:markdown