ci.yml

name: CI


on:
  pull_request:
  push:
    branches:
      - 'main'
      - 'pre-commit-autoupdate'
    tags:
      - '*'
  schedule:
    # daily (`@daily` not supported, see
    # https://docs.github.com/en/actions/reference/events-that-trigger-workflows#scheduled-events )
    #
    # Runs on default/base branch (see
    # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule )
    - cron: '0 0 * * *'


jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
        numfocus_nightly: [false]
        os: ["ubuntu-latest"]
        pandas: [""]
        pyarrow: ["4.0.1", "nightly"]
        python: ["3.8"]
        include:
          - numfocus_nightly: true
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "4.0.1"
            python: "3.10"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: "1.5.3"
            pyarrow: "4.0.1"
            python: "3.11"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: "1.5.3"
            pyarrow: "13.0.0"
            python: "3.11"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "5.0.0"
            python: "3.9"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "6.0.1"
            python: "3.9"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "7.0.0"
            python: "3.10"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "8.0.1"
            python: "3.10"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "9.0.0"
            python: "3.10"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "10.0.1"
            python: "3.11"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "11.0.0"
            python: "3.11"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "12.0.0"
            python: "3.11"
          - numfocus_nightly: false
            os: "ubuntu-latest"
            pandas: ""
            pyarrow: "13.0.0"
            python: "3.11"
          - numfocus_nightly: false
            os: "macos-latest"
            pandas: ""
            pyarrow: "4.0.1"
            python: "3.8"
    continue-on-error: ${{ matrix.numfocus_nightly || matrix.pyarrow == 'nightly' }}

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

    defaults:
      run:
        # see https://github.com/conda-incubator/setup-miniconda/#important
        shell: bash -l {0}

    env:
      IS_MASTER_BUILD: ${{ !matrix.numfocus_nightly && matrix.os == 'ubuntu-latest' && matrix.pyarrow == '4.0.1' && matrix.python == '3.8' }}
      IS_TAG: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')}}

    steps:
      # CI setup
      - name: Is Master Build?
        run: echo $IS_MASTER_BUILD
      - name: Checkout
        uses: actions/checkout@v4
      - name: Set up Conda env
        uses: mamba-org/setup-micromamba@2b72821d5ad7f6da3c003a3684ce341bf187b46f
        with:
          environment-file: environment.yml
          cache-environment: true
          create-args: >-
            python=${{ matrix.PYTHON_VERSION }}
      - name: Install Pyarrow (non-nightly)
        # Don't pin python as older versions of pyarrow require older versions of python
        # Pin asv so it doesn't get updated before the benchmarks are run
        run: micromamba install -y --no-py-pin pyarrow==${{ matrix.pyarrow }} "pandas<2.1.0"
        if: matrix.pyarrow != 'nightly' && matrix.pandas == ''
      - name: Install Pyarrow (nightly)
        # Install both arrow-cpp and pyarrow to make sure that we have the
        # latest nightly of both packages. It is sadly not guaranteed that the
        # nightlies and the latest release would otherwise work together.
        run: micromamba update -c arrow-nightlies -c conda-forge arrow-cpp pyarrow
        if: matrix.pyarrow == 'nightly'
      - name: Install Pyarrow (downgrade pandas)
        run: micromamba install -y --no-py-pin pyarrow==${{ matrix.pyarrow }} pandas==${{ matrix.pandas }}
        if: matrix.pyarrow != 'nightly' && matrix.pandas != ''
      - name: Pip Install NumFOCUS nightly
        # NumFOCUS nightly wheels, contains numpy and pandas
        # TODO(gh-45): Re-add numpy
        # TODO: Remove pandas version pin once https://github.com/pandas-dev/pandas/issues/55014 is fixed
        run: python -m pip install --pre --upgrade --timeout=60 --extra-index-url https://pypi.anaconda.org/scipy-wheels-nightly/simple "pandas<2.1.0"
        if: matrix.numfocus_nightly
      - name: Install repository
        run: python -m pip install --no-build-isolation --no-deps --disable-pip-version-check -e .
      - name: Test import
        run: |
          python -c "import plateau"
          python -c "import plateau.api"
          python -c "import plateau.api.dataset"
          python -c "import plateau.api.serialization"
          python -c "import plateau.core"
          python -c "import plateau.io"
          python -c "import plateau.io_components"
          python -c "import plateau.serialization"
          python -c "import plateau.utils"

      # Tests
      - name: Pytest
        # FIXME: Add `-n auto` again to allow for parallelism here.
        run: pytest --cov --cov-report xml

      - name: Running benchmarks
        run: |
          asv --config ./asv_bench/asv.conf.json machine --machine github --os unknown --arch unknown --cpu unknown --ram unknown
          asv --config ./asv_bench/asv.conf.json run -E existing:same | sed "/failed$/ s/^/##[error]/" | tee benchmarks.log
          if grep "failed" benchmarks.log > /dev/null ; then
              exit 1
          fi
        if: env.IS_MASTER_BUILD == 'true'

      # Builds
      - name: Build Wheel and sdist
        run: python -m build --no-isolation

      - name: Codecov
        uses: codecov/codecov-action@v3.1.4
        with:
          # NOTE: `token` is not required, because the plateau repo is public
          file: ./coverage.xml
          name: pytest-numfocus_nightly_${{ matrix.numfocus_nightly }}-os_${{ matrix.os }}-pyarrow_${{ matrix.pyarrow }}-python_${{ matrix.python }}

      # Release
      - name: Publish to PyPI
        if: env.IS_MASTER_BUILD == 'true' && env.IS_TAG == 'true'
        uses: pypa/gh-action-pypi-publish@master
        with:
          user: __token__
          password: ${{ secrets.PYPI_PASSWORD }}