validate-markdown.yaml

name: validate-markdown

# Author: @ralfhandl based on work of @MikeRalphson
# Issue: https://github.com/OAI/Overlay-Specification/issues/53

#
# This workflow validates markdown files in the versions directory matching *.md
#

# run this on pull-requests (creation and updates) and on manual trigger
on:
  pull_request: {}
  workflow_dispatch: {}

jobs:
  lint:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v5 # checkout repo content
        with:
          fetch-depth: 0

      - uses: actions/setup-node@v6 # setup Node.js
        with:
          node-version: "22.x"

      - name: Lint markdown
        run: npx --yes markdownlint-cli2 --config .markdownlint.yaml npx markdownlint-cli2 *.md schemas/**/*.md versions/*.md

      - name: Check links in markdown files
        uses: umbrelladocs/action-linkspector@v1
        with:
          reporter: github-check
          fail_level: any
          filter_mode: file