name: Check Markdown

on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]
  merge_group:

permissions:
  packages: read

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

    steps:
      - name: Checkout sources
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

      - uses: actions/setup-node@v4.0.1
        with:
          node-version: "18.x"
          registry-url: "https://npm.pkg.github.com"
          scope: "@paritytech"

      - name: Install tooling
        run: |
          npm install -g markdownlint-cli
          markdownlint --version

      - name: Check Markdown
        env:
          CONFIG: .github/.markdownlint.yaml
        run: |
          echo "Checking markdown formatting. More info: docs/contributor/markdown_linting.md"
          markdownlint --config "$CONFIG" --ignore target .