Add pattern checks for linting #3063
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2 | |
| with: | |
| egress-policy: audit # TODO: change to 'egress-policy: block' after couple of runs | |
| - name: "Checkout" | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| fetch-depth: 0 | |
| - name: "Setup Python" | |
| uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0 | |
| 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@bab30c2299617f6615ec02a68b9a40d10bd21366 # v45.0.5 | |
| 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@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3 | |
| with: | |
| name: pull_request_number | |
| path: pull_request_number.txt | |
| if-no-files-found: error | |
| retention-days: 5 |