yaml.yml

name: Yamllint

# Run yamllint on PRs.  This ignores many pre-existing errors in the src/tests/ftests directory
# however those are silenced via the .yamllint file.

# Checks out a merge of the PR onto the target branch  so should test the code as landed, not as it
# is in the PR.

on:
  pull_request:
    paths:
      - '**/*.yaml'
      - '**/*.yml'
      - utils/cq/requirements.txt

permissions: {}

jobs:
  yaml-lint:
    runs-on: ubuntu-22.04
    name: Yamllint check
    steps:
      - name: Check out source repository
        uses: actions/checkout@v4
        with:
          ref: ${{ github.event.pull_request.head.sha }}
      - name: Set up Python environment
        uses: actions/setup-python@v5
        with:
          python-version: '3'
      - name: Install extra python packages
        run: pip install --requirement utils/cq/requirements.txt
      - name: Run check
        run: yamllint --format github .