test_and_deploy.yml

name: tests

on:
  push:
    branches:
      - main
    tags:
      - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
  pull_request:
    branches:
      - main
  workflow_dispatch:

jobs:
  linting:
    runs-on: ubuntu-latest
    steps:
      - uses: neuroinformatics-unit/actions/lint@v2

  manifest:
    name: Check Manifest
    runs-on: ubuntu-latest
    steps:
      - uses: neuroinformatics-unit/actions/check_manifest@v2

  test:
    needs: [linting, manifest]
    name: ${{ matrix.os }} py${{ matrix.python-version }}
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        # Run all supported Python versions on linux
        python-version: ["3.10", "3.11", "3.12"]
        os: [ubuntu-latest]
        # Include one windows and ARM/Intel macos run
        include:
        - os: macos-13 # Intel Mac
          python-version: "3.12"
        - os: macos-latest # ARM Mac
          python-version: "3.12"
        - os: windows-latest
          python-version: "3.12"

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

      # these libraries enable testing on Qt on linux
      - uses: pyvista/setup-headless-display-action@v2
        with:
          qt: true

      # cache atlases needed by the tests
      - name: Cache Atlases
        id: atlas-cache
        uses: actions/cache@v3
        with:
          path: | # ensure we don't cache any interrupted atlas download and extraction!
            ~/.brainglobe/*
            !~/.brainglobe/atlas.tar.gz
          key: ${{ runner.os }}-cached-atlases
          enableCrossOsArchive: false # ~ and $HOME evaluate to different places across OSs!

      - if: ${{ steps.atlas-cache.outputs.cache-hit == 'true' }}
        name: List files in brainglobe data folder # good to be able to sanity check that user data is as expected
        run: |
          ls -af ~/.brainglobe/

      # Run tests
      - uses: neuroinformatics-unit/actions/test@v2
        with:
          python-version: ${{ matrix.python-version }}
          secret-codecov-token: ${{ secrets.CODECOV_TOKEN }}

  build_sdist_wheels:
    name: Build source distribution
    needs: [test]
    if: github.event_name == 'push' && github.ref_type == 'tag'
    runs-on: ubuntu-latest
    steps:
    - uses: neuroinformatics-unit/actions/build_sdist_wheels@v2


  upload_all:
    name: Publish build distributions
    needs: [build_sdist_wheels]
    runs-on: ubuntu-latest
    steps:
    - uses: neuroinformatics-unit/actions/upload_pypi@v2
      with:
        secret-pypi-key: ${{ secrets.TWINE_API_KEY }}