ci.yml

name: CI
on:
  pull_request:
  push:
    branches:
      - main
  workflow_call:
    outputs:
      artifact-name:
        description: "Name of the uploaded artifact; use for artifact retrieval."
        value: ${{ jobs.package.outputs.artifact-name }}

# Cancel active CI runs for a PR before starting another run
concurrency:
  group: ${{ github.ref }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash  # https://github.com/beeware/briefcase/pull/912

env:
  FORCE_COLOR: "1"

jobs:
  pre-commit:
    name: Pre-commit checks
    uses: beeware/.github/.github/workflows/pre-commit-run.yml@main

  towncrier:
    name: Check towncrier
    uses: beeware/.github/.github/workflows/towncrier-run.yml@main

  package:
    name: Python package
    uses: beeware/.github/.github/workflows/python-package-create.yml@main

  unit-tests:
    name: Unit tests
    needs: [ pre-commit, towncrier, package ]
    runs-on: ${{ matrix.platform }}-latest
    continue-on-error: ${{ matrix.experimental }}
    strategy:
      fail-fast: false
      matrix:
        platform: [ "macos", "ubuntu", "windows" ]
        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12" ]
        include:
        - experimental: false
        # Allow dev Python to fail without failing entire job
        #- python-version: "3.13-dev"
        #  experimental: true
        # Run tests against the latest Windows Store Python
        - platform: "windows"
          python-version: "winstore3.12"
          experimental: false
    steps:
    - name: Checkout
      uses: actions/checkout@v4.1.1
      with:
        fetch-depth: 0

    - name: Set up Python
      if: startswith(matrix.python-version, '3')
      uses: actions/setup-python@v4.7.1
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install Windows Store Python
      if: startswith(matrix.python-version, 'winstore')
      uses: beeware/.github/.github/actions/install-win-store-python@main
      with:
        python-version: "3.12"

    - name: Get Packages
      uses: actions/download-artifact@v3.0.2
      with:
        name: ${{ needs.package.outputs.artifact-name }}
        path: dist

    - name: Install dev Dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install --upgrade setuptools build wheel
        # Utility script installs tox as defined in pyproject.toml
        python -m install_requirement --extra dev tox

    - name: Test
      id: test
      env:
        COVERAGE_FILE: ".coverage.${{ matrix.platform }}.${{ matrix.python-version }}"
      run: tox -e py --installpkg dist/briefcase-*.whl

    - name: Store Coverage Data
      if: always() && contains('success,failure', steps.test.outcome)
      uses: actions/upload-artifact@v3.1.3
      with:
        name: coverage-data
        path: ".coverage.*"
        if-no-files-found: ignore

    - name: Report Platform Coverage
      id: coverage
      if: always() && contains('success,failure', steps.test.outcome)
      # coverage reporting must use the same Python version used to produce coverage
      run: tox -qe coverage$(echo '${{ matrix.python-version }}' | tr -dc '0-9')

  coverage:
    name: Project coverage
    runs-on: ubuntu-latest
    needs: unit-tests
    if: always() && contains('success,failure', needs.unit-tests.result)
    steps:
    - name: Checkout
      uses: actions/checkout@v4.1.1
      with:
        fetch-depth: 0

    - name: Setup Python
      uses: actions/setup-python@v4.7.1
      with:
        # Use minimum version of python for coverage to avoid phantom branches
        # https://github.com/nedbat/coveragepy/issues/1572#issuecomment-1522546425
        python-version: "3.8"

    - name: Install dev Dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install --upgrade setuptools build wheel
        # Utility script installs tox as defined in pyproject.toml
        python -m install_requirement --extra dev tox

    - name: Retrieve Coverage Data
      uses: actions/download-artifact@v3.0.2
      with:
        name: coverage-data

    - name: Platform Coverage Reports
      id: platform-coverage
      run: >
        tox p --parallel-no-spinner -qe
        coverage-ci-platform-linux,coverage-ci-platform-macos,coverage-ci-platform-windows

    - name: Project Coverage Report
      id: project-coverage
      if: always() || contains('success,failure', needs.platform-coverage.result)
      run: tox -qe coverage-ci-project-html

    - name: Upload Project Coverage HTML Report
      if: always() && steps.project-coverage.outcome == 'failure'
      uses: actions/upload-artifact@v3.1.3
      with:
        name: html-coverage-report-project
        path: htmlcov

  verify-apps:
    name: Build app
    needs: unit-tests
    uses: beeware/.github/.github/workflows/app-build-verify.yml@main
    with:
      # This *must* be the version of Python that is the system Python on the
      # Ubuntu version used to run Linux tests. We use a fixed ubuntu-22.04
      # rather than `-latest` because at some point, `-latest` will become
      # `-24.04`, but it will be a soft changeover, which will cause havoc with
      # the hard Python version requirement for local system packages.
      python-version: "3.10"
      runner-os: ${{ matrix.runner-os }}
      framework: ${{ matrix.framework }}
    strategy:
      fail-fast: false
      matrix:
        framework: [ "toga", "pyside2", "pyside6", "ppb", "pygame" ]
        runner-os: [ "macos-latest", "ubuntu-22.04", "windows-latest" ]
        exclude:
          # Pyside2 doesn't publish ARM64 wheels, and is unlikely to ever do so.
          # This means we can't make a universal binary.
          - framework: "pyside2"
            runner-os: "macos-latest"