name: Markdown Lint

on:
  workflow_dispatch:
  pull_request:
    branches: [ "amd-staging" ]
    paths:
        - '*.md'

jobs:
  check-readme:
    runs-on: ubuntu-latest
    steps:
    - name: Check out code
      uses: actions/checkout@v3

    - name: Lint Markdown files
      uses: avto-dev/markdown-lint@v1
      with:
        config: './.markdown-lint-config.yml'
        args: './README.md'