python-package.yml

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Python package

on:
  push:
    branches: [ main ]
    tags:
      - 'v*.*.*'
  pull_request:
    branches: [ main ]

jobs:
  build:
    strategy:
      matrix:
        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
        platform: ['ubuntu-latest', 'macos-latest', 'windows-latest']
        architecture: ['x64']
        include:
          - architecture: 'x86'
            platform: 'windows-latest'
            python-version: 3.11

    runs-on: ${{ matrix.platform }}

    steps:
    - uses: actions/checkout@v3
    - name: Setup FFmpeg
      uses: FedericoCarboni/setup-ffmpeg@v2
    - name: Set up ${{ matrix.architecture }} Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}
        # optional x64 or x86. Defaults to x64 if not specified
        architecture: ${{ matrix.architecture }}
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install .
        python -m pip install -r requirements-dev.txt
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
    - name: Lint with black
      run: |
        black --check mapillary_tools tests
    - name: Sort imports with usort
      run: |
        usort diff mapillary_tools/
    - name: Type check with mypy
      run: |
        mypy mapillary_tools
    - name: Test with pytest
      run: |
        mapillary_tools --version
        pytest tests
      env:
        MAPILLARY_TOOLS_EXECUTABLE: mapillary_tools
    - name: Build and test with Pyinstaller on MacOS (Python 3.11 only)
      # Enable for Python3.11 only because it often fails at codesign (subprocess timeout)
      if: matrix.platform == 'macos-latest' && startsWith(github.ref, 'refs/tags/') && matrix.python-version == 3.11
      run: |
        # see https://github.com/mapillary/mapillary_tools/issues/566
        # TODO: move it to extras in setup.py
        python3 -m pip install pysocks
        ./script/build_osx
        # Could run full integration tests with the binary (it might be slow)
        pytest tests/integration
      env:
        MAPILLARY_TOOLS_EXECUTABLE: ./dist/osx/mapillary_tools
    - name: Build and test with Pyinstaller on Ubuntu (Python 3.11 only)
      if: matrix.platform == 'ubuntu-latest' && startsWith(github.ref, 'refs/tags/') && matrix.python-version == 3.11
      run: |
        # see https://github.com/mapillary/mapillary_tools/issues/566
        # TODO: move it to extras in setup.py
        python3 -m pip install pysocks
        ./script/build_linux
        # Could run full integration tests with the binary (it might be slow)
        pytest tests/integration
      env:
        MAPILLARY_TOOLS_EXECUTABLE: ./dist/linux/mapillary_tools
    - name: Build and test with Pyinstaller on Windows (Python 3.11 only)
      if: matrix.platform == 'windows-latest' && startsWith(github.ref, 'refs/tags/') && matrix.python-version == 3.11
      run: |
        # see https://github.com/mapillary/mapillary_tools/issues/566
        # TODO: move it to extras in setup.py
        python3 -m pip install pysocks
        ./script/build_bootloader.ps1
        ./script/build_win.ps1
        # Could run full integration tests with the binary (it might be slow)
        cp ./dist/win/mapillary_tools.exe mapillary_tools_WINDOWS_VERY_HARD_TO_FIND_YOU_IN_ANOTHER_DIR_SO_I_MOVE_YOU_HERE.exe
        pytest tests/integration
      env:
        MAPILLARY_TOOLS_EXECUTABLE: mapillary_tools_WINDOWS_VERY_HARD_TO_FIND_YOU_IN_ANOTHER_DIR_SO_I_MOVE_YOU_HERE.exe
    - name: Release
      uses: softprops/action-gh-release@v1
      if: startsWith(github.ref, 'refs/tags/') && matrix.python-version == 3.11
      with:
        draft: true
        generate_release_notes: true
        fail_on_unmatched_files: false
        files: |
          ./dist/releases/*