name: "doc-validator"
on:
  workflow_dispatch:
    inputs:
      include:
        description: |
          Regular expression that matches paths to include in linting.

          For example: docs/sources/(?:alerting|fundamentals)/.+\.md
        required: true
jobs:
  doc-validator:
    runs-on: "ubuntu-latest"
    container:
      image: "grafana/doc-validator:v5.2.0"
    steps:
      - name: "Checkout code"
        uses: "actions/checkout@v4"
      - name: "Run doc-validator tool"
        # Only run doc-validator on specific directories.
        run: >
          doc-validator
          '--include=${{ inputs.include }}'
          '--skip-checks=^(?:image.+|canonical-does-not-match-pretty-URL)$'
          ./docs/sources
          /docs/grafana/latest