markdown-lint.yml

---

name: Markdown Lint

on: # yamllint disable-line rule:truthy
  push:
    branches: ["main"]
  pull_request:
    # The branches below must be a subset of the branches above
    branches: ["main"]
  workflow_dispatch:

jobs:
  build:

    runs-on: ubuntu-latest

    strategy:
      matrix:
        os: ["ubuntu-latest"]
        node-version: [20.x]
        # See supported Node.js release
        # schedule at https://nodejs.org/en/about/releases/

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js ${{ matrix.node-version }}
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}

      - name: Install dependencies
        run: npm install -g markdownlint-cli

      - name: Lint
        run: >
          markdownlint '**/*.md' --ignore node_modules
          && echo '✔  Your code looks good.'