lint.yml

# Copyright The InstructLab Authors, 2024
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Lint

on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - compositional_skills/**/qna.yaml
      - knowledge/**/qna.yaml

  pull_request:
    branches:
      - main
    paths:
      - compositional_skills/**/*.yaml
      - compositional_skills/**/*.yml
      - knowledge/**/*.yaml
      - knowledge/**/*.yml

defaults:
  run:
    shell: bash

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - name: "Checkout"
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          submodules: true

      - name: "Find changed skills and knowledge files"
        id: changed-files
        uses: tj-actions/changed-files@v42
        with:
          files: |
            compositional_skills/**/*.yaml
            compositional_skills/**/*.yml
            knowledge/**/*.yaml
            knowledge/**/*.yml

      - name: "Setup Python"
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: "Install Python Packages"
        if: steps.changed-files.outputs.any_changed == 'true'
        run: |
          pip install -r .github/scripts/requirements.txt

      - name: "Check YAML file contents"
        if: steps.changed-files.outputs.any_changed == 'true'
        run: |
          .github/scripts/check-yaml.py ${{ steps.changed-files.outputs.all_changed_files }}
        env:
          SCHEMA_BASE: schema
          YAMLLINT_CONFIG: "{extends: relaxed, rules: {line-length: {max: 120}}}"
          TAXONOMY_FOLDERS: >-
            compositional_skills
            knowledge