build.yml

# Build Python Source/Wheel Distributions of DVR-Scan
name: Python Distribution

on:
  schedule:
    - cron: '0 0 * * *'
  pull_request:
    paths:
      - dist/**
      - dvr_scan/**
      - tests/**
  push:
    paths:
      - dist/**
      - dvr_scan/**
      - tests/**
    branches:
      - main
      - develop
      - 'releases/**'
    tags:
      - v*-release
  workflow_dispatch:

jobs:
  build:
    env:
        # Set below after building the final package.
        dvr_scan_version: ""
        UV_SYSTEM_PYTHON: 1

    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [macos-13, macos-14, ubuntu-20.04, ubuntu-latest, windows-latest]
        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]

    steps:
      - uses: actions/checkout@v4

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

      - name: Install uv and set the python version
        uses: astral-sh/setup-uv@v4
        with:
          version: "0.5.11"
          python-version: ${{ matrix.python-version }}

      - name: Install Dependencies
        run: |
          uv pip install --upgrade build wheel virtualenv
          uv pip install opencv-python-headless opencv-contrib-python-headless --only-binary :all:
          uv pip install -r requirements_headless.txt -r docs/requirements.txt

      - name: Setup FFmpeg
        # TODO: This action currently does not work for non-x64 builders (e.g. macos-14):
        # https://github.com/federicocarboni/setup-ffmpeg/issues/21
        if: ${{ runner.arch == 'X64' }}
        uses: ./.github/actions/setup-ffmpeg
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Unit Test
        run: |
          python -m pytest tests

      - name: Build Package
        shell: bash
        run: |
          python dist/pre_release.py
          python -m build
          echo "dvr_scan_version=`python -c \"import dvr_scan; print(dvr_scan.__version__.replace('-', '.'))\"`" >> "$GITHUB_ENV"

      - name: Smoke Test (Source)
        run: |
          uv pip install dist/dvr_scan-${{ env.dvr_scan_version }}.tar.gz
          python -m dvr_scan --version
          python -m dvr_scan -i tests/resources/simple_movement.mp4 -so -df 4 -et 100
          uv pip uninstall dvr-scan

      - name: Smoke Test (Wheel)
        run: |
          uv pip install dist/dvr_scan-${{ env.dvr_scan_version }}-py3-none-any.whl
          python -m dvr_scan --version
          python -m dvr_scan -i tests/resources/simple_movement.mp4 -so -df 4 -et 100
          uv pip uninstall dvr-scan

      - name: Upload Package
        if: ${{ matrix.python-version == '3.13' && matrix.os == 'ubuntu-latest' }}
        uses: actions/upload-artifact@v3
        with:
          name: dvr-scan-dist
          path: |
            dist/*.tar.gz
            dist/*.whl