commitflow-py3.yml

name: Python 3 CI

on:
  push:
    branches:
    - master
  pull_request:
    branches:
    - master
jobs:
  hue-build-and-tests:

    runs-on: ubuntu-latest

    strategy:
      matrix:
        python-version: ['3.8', '3.9', '3.10', '3.11']

    steps:
    - name: Checkout
      uses: actions/checkout@v4
      with:
        fetch-depth: 0

    - name: Check commit title format
      run: |
        ./tools/ci/check_for_commit_message.sh

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}

    - name: Cache pip
      uses: actions/cache@v4
      with:
        # This path is specific to Ubuntu
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ hashFiles('desktop/core/generate_requirements.py') }}
        restore-keys: |
          ${{ runner.os }}-pip-
          ${{ runner.os }}-

    - name: Setup node 20 and cache npm
      uses: actions/setup-node@v4
      with:
        node-version: 20
        cache: 'npm'

    - name: Build Hue
      run: |
        sudo apt-get update
        sudo apt-get install -y build-essential asciidoc libkrb5-dev libldap2-dev libsasl2-dev libxslt-dev libsasl2-modules-gssapi-mit libsnappy-dev libgdbm-dev

        export PYTHON_VER=python${{ matrix.python-version }}
        export SKIP_PYTHONDEV_CHECK=true
        export ROOT=$PWD
        make apps test_prep

    - name: Run unit tests
      run: |
        if [[ "${{ matrix.python-version }}" == "3.11" ]]; then
          ./build/env/bin/pytest
        else
          ./build/venvs/python${{ matrix.python-version }}/bin/pytest
        fi

    - name: Run python lint check
      run: |
        if [[ "${{ matrix.python-version }}" == "3.11" ]]; then
          PYTHONWARNINGS=always ./build/env/bin/hue runruff check
        else
          PYTHONWARNINGS=always ./build/venvs/python${{ matrix.python-version }}/bin/hue runruff check
        fi

    - name: Run documentation lint check
      run: |
        curl -O https://dl.google.com/go/go1.23.4.linux-amd64.tar.gz
        tar -xvf go1.23.4.linux-amd64.tar.gz
        go/bin/go install github.com/raviqqe/muffet/v2@latest

        curl --output hugo_0.69.0_Linux.tar.gz -L https://github.com/gohugoio/hugo/releases/download/v0.69.0/hugo_0.69.0_Linux-64bit.tar.gz
        tar -xvf hugo_0.69.0_Linux.tar.gz

        export PATH=$PWD:$HOME/go/bin:$PATH

        # Trigger linting if documentation changes
        ./tools/ci/check_for_website_dead_links.sh docs/docs-site
        # ./tools/ci/check_for_website_dead_links.sh docs/gethue

    - name: Upload reports
      if: matrix.python-version == '3.11'
      uses: actions/upload-artifact@v4
      with:
        name: hue-reports
        path: ./reports