e3sm-gh-md-linter.yml

name: markdown

# if .md files are touched in a PR, lint them!

on:
  pull_request:
    branches: ["master"]
    paths:
        - '**/*.md'
        # for now let's not lint files in eamxx
        - '!components/eamxx/**/*.md'

jobs:
  linter:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
      with:
        fetch-depth: 0
    - uses: tj-actions/changed-files@v45
      id: changed-files
      with:
        files: '**/*.md'
        separator: ","
    - uses: DavidAnson/markdownlint-cli2-action@v17
      if: steps.changed-files.outputs.any_changed == 'true'
      with:
        config: 'docs/.markdownlint.json'
        globs: ${{ steps.changed-files.outputs.all_changed_files }}
        separator: ","