name: ORFS variables.yaml tester and linter

on:
  pull_request:

permissions:
  contents: read

jobs:
  docs-test-job:
    name: 'Tests for variables.yaml'
    if: github.event_name == 'pull_request' || github.event_name == 'push'
    runs-on: ${{ vars.USE_SELF_HOSTED == 'true' && 'self-hosted' || 'ubuntu-latest' }}
    steps:
    - name: Checkout repository
      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
      with:
        fetch-depth: 1
        sparse-checkout: |
          flow/scripts/generate-variables-docs.py
          flow/scripts/yaml_to_json.py
          flow/scripts/variables.yaml
          flow/scripts/variables.json
          docs/user/FlowVariables.md
          yamlfix.toml
          .github/requirements/requirements_lock.txt
    - uses: actions/setup-python@v7
      with:
        python-version: "3.10"
    - name: Install dependencies
      run: |
        python3 -m venv venv
        venv/bin/pip install --quiet -r .github/requirements/requirements_lock.txt
    - name: Run generate-variables-docs.py
      run: |
        venv/bin/python3 flow/scripts/generate-variables-docs.py
    - name: Check if FlowVariables.md is up to date
      run: |
        git diff --exit-code docs/user/FlowVariables.md
    - name: Check variables.json is up to date
      run: |
        venv/bin/python3 flow/scripts/yaml_to_json.py
        git diff --exit-code flow/scripts/variables.json
    - name: Run yamlfix check
      run: |
        source venv/bin/activate
        yamlfix --version
        set -x
        yamlfix -c yamlfix.toml flow/scripts/variables.yaml
        git diff --exit-code flow/scripts/variables.yaml