lint.yml

# SPDX-License-Identifier: Apache-2.0

name: Lint compositional_skills and knowledge

on:
  workflow_dispatch:
  push:
    branches:
      - main
    paths:
      - compositional_skills/**/qna.yaml
      - knowledge/**/qna.yaml
      - '.github/workflows/lint.yml' # This workflow
      - 'scripts/**' # Scripts used by this workflow

  pull_request:
    branches:
      - main
    paths:
      - compositional_skills/**/*.yaml
      - compositional_skills/**/*.yml
      - knowledge/**/*.yaml
      - knowledge/**/*.yml
      - '.github/workflows/lint.yml' # This workflow
      - 'scripts/**' # Scripts used by this workflow

env:
  LC_ALL: en_US.UTF-8

defaults:
  run:
    shell: bash

permissions:
  contents: read

jobs:
  yamllint:
    runs-on: ubuntu-latest
    steps:
      - name: "Harden Runner"
        uses: step-security/harden-runner@5c7944e73c4c2a096b17a9cb74d65b6c2bbafbde # v2.9.1
        with:
          egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs

      - name: "Checkout"
        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
        with:
          fetch-depth: 0

      - name: "Setup Python"
        uses: actions/setup-python@39cd14951b08e74b54015e9e001cdefcf80e669f # v5.1.1
        with:
          python-version: "3.11"

      - name: "Install Python Packages"
        run: |
          pip install -r scripts/requirements.txt

      - name: "Find changed skills and knowledge files"
        id: changed-files
        uses: tj-actions/changed-files@40853de9f8ce2d6cfdc73c1b96f14e22ba44aec4 # v45.0.0
        with:
          files: |
            compositional_skills/**/*.yaml
            compositional_skills/**/*.yml
            knowledge/**/*.yaml
            knowledge/**/*.yml

      - name: "Check changed YAML file contents"
        if: ${{ fromJSON(steps.changed-files.outputs.any_changed) }}
        run: |
          scripts/check-yaml.py ${{ steps.changed-files.outputs.all_changed_files }}
        env:
          TAXONOMY_FOLDERS: >-
            compositional_skills
            knowledge

      - name: "Check all YAML file contents"
        if: ${{ !fromJSON(steps.changed-files.outputs.any_changed) }}
        run: |
          read -ra folders <<< "${TAXONOMY_FOLDERS}"
          # shellcheck disable=SC2046
          scripts/check-yaml.py $(find "${folders[@]}" -name "qna.yaml" -print)
        env:
          SCHEMA_VERSION: 0 # use the schema version specified in the "version" key
          TAXONOMY_FOLDERS: >-
            compositional_skills
            knowledge

      - name: "Save Pull Request number"
        if: ${{ (github.event_name == 'pull_request') && (github.repository == 'instructlab/taxonomy') }}
        run: |
          echo "${PULL_REQUEST_NUMBER}" > pull_request_number.txt
        env:
          PULL_REQUEST_NUMBER: ${{ fromJSON(steps.changed-files.outputs.any_changed) && github.event.number || '0' }}

      - name: "Upload Pull Request number"
        if: ${{ (github.event_name == 'pull_request') && (github.repository == 'instructlab/taxonomy') }}
        uses: actions/upload-artifact@834a144ee995460fba8ed112a2fc961b36a5ec5a # v4.3.6
        with:
          name: pull_request_number
          path: pull_request_number.txt
          if-no-files-found: error
          retention-days: 5