md-lint.yml

name: Lint Docs

on:
  push:
    branches-ignore:
      - master
      - main
    paths:
       - "**/*.md"
  pull_request:
    branches:
      - master
      - main
    paths:
       - "**/*.md"

permissions:
  contents: read # to fetch code (actions/checkout)

jobs:
  build:
    name: Lint Markdown
    runs-on: ubuntu-latest

    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
        with:
          persist-credentials: false
        
      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 'lts/*'

      - name: Install Linter
        run: npm install --ignore-scripts

      - name: Add Matcher
        uses: xt0rted/markdownlint-problem-matcher@1a5fabfb577370cfdf5af944d418e4be3ea06f27

      - name: Run Linter
        run: ./node_modules/.bin/markdownlint-cli2