check.yml

name: Checks

on:
  push:
  pull_request:

jobs:
  build:

    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10']
        os: [macos-latest, ubuntu-latest, windows-latest]
    env:
      # Display must be available globally for linux to know where xvfb is
      DISPLAY: :0

    steps:
    - uses: actions/checkout@main
      with:
        fetch-depth: 0
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@main
      with:
        python-version: ${{ matrix.python-version }}
    # Temporary fix for 'pip install imageio-ffmpeg'
    # not including the FFMPEG binary on Apple Silicon macs
    # This step can be removed when issue is fixed in imageio-ffmpeg
    # https://github.com/imageio/imageio-ffmpeg/issues/71
    - name: Setup FFmpeg
      if: runner.name == 'macos-latest'
      run: |
        brew update
        brew install ffmpeg
    # Temporary fix for 'pip install imageio-ffmpeg'
    # not including the FFMPEG binary on Apple Silicon macs
    # This step can be removed when issue is fixed in imageio-ffmpeg
    # https://github.com/imageio/imageio-ffmpeg/issues/71
    - name: Setup FFmpeg
      if: runner.os == 'macOS'
      uses: AnimMouse/setup-ffmpeg@v1
    - name: Setup xvfb (Linux)
      if: runner.os == 'Linux'
      run: |
        sudo apt-get update
        sudo apt-get install -y xvfb libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-shape0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0
        # start xvfb in the background
        sudo /usr/bin/Xvfb $DISPLAY -screen 0 1280x1024x24 &
    - name: Install Python dependencies
      run: |
        # prerequisites
        python -m pip install --upgrade pip wheel
        python -m pip install coverage flake8 pytest pytest-qt
        # install dependencies
        pip install .
        # show installed packages
        pip freeze
    - name: Start application and print version
      env:
        # Display must be available globally for linux to know where xvfb is
        QT_DEBUG_PLUGINS: 1
      run: |
        python -m dckit --version
    - name: Test with pytest
      run: |
         coverage run --source=dckit -m pytest tests
    - name: Lint with flake8
      run: |
        flake8 --exclude _version.py .
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v4
    - name: Create app and check if it runs (macOS)
      if: runner.os == 'macOS'
      working-directory: ./build-recipes
      run: |
        bash ./macos_build_app.sh DCKit $(python -m dckit --version)