test.yml

name: Test

on:
  workflow_dispatch:  # Allows manual triggering
  pull_request:
  push:
    branches:
      - main
  schedule:
    # run every Monday at 6am UTC
    - cron: '0 6 * * 1'

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    strategy:
      max-parallel: 4
      fail-fast: false
      matrix:
        python-version: ["3.10","3.11", "3.12"]
        platform: [ubuntu-latest, macos-latest, windows-latest]
        exclude:
          # This case is handled in the coverage/remote data run
          - python-version: "3.11"
            platform: ubuntu-latest
        include:
          # In the run on python 3.11 on ubuntu include running coverage
          # and remote data. Do both tests together to get best coverage
          # estimate.
          - python-version: "3.11"
            platform: ubuntu-latest
            coverage: true
            toxposargs: --remote-data=any

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

    steps:
      - name: Check out repository
        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 dependencies
        run: |
          python -m pip install --upgrade pip tox
      - name: Install batman
        run: |
          pip install batman-package
      - if: ${{ ! matrix.coverage }}
        name: Run tests
        run: |
          tox -e ${{ matrix.python-version }}-test -- ${{ matrix.toxposargs }}

      - if: ${{ matrix.coverage }}
        name: Run tests with coverage
        run: |
          tox -e coverage -- ${{ matrix.toxposargs }}

      - if: ${{ matrix.coverage }}
        name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@v5
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        with:
          files: ./coverage.xml
          verbose: true

  linting:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v4
      - name: Set up Python 3.11
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
          cache: 'pip'
      - name: Install tox
        run: |
          python -m pip install --upgrade pip
          pip install tox
      - name: Lint with ruff
        run: |
          tox -e lint

  documentation:
    runs-on: ubuntu-latest
    steps:

      - uses: actions/checkout@v4

      - name: Set up Python 3.11
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
          cache: 'pip'
      - name: Install tox
        run: |
          python -m pip install --upgrade pip
          pip install tox
      - name: Install stellarphot
        run: |
          pip install .

      - name: Install batman
        run: |
          pip install batman-package

      - name: Setup Graphviz
        uses: ts-graphviz/setup-graphviz@v2

      - name: Run tests
        run: |
          tox -e build_docs

  table_representation:
    runs-on: ubuntu-latest
    steps:

      - uses: actions/checkout@v4

      - name: Set up Python 3.11
        uses: actions/setup-python@v5
        with:
          python-version: 3.11
          cache: 'pip'
      - name: Install tox
        run: |
          python -m pip install --upgrade pip
          pip install tox

      - name: Test table representation
        run: |
          tox -e table_rep