main.yml

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Checks & tests

on:
  push:
    branches: [ main ]
    paths-ignore:
      - '**.md'

  pull_request:
    branches: [ main ]
    paths-ignore:
      - '**.md'

  schedule:
      # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
      #
      #      ┌───────────── minute (0 - 59)
      #      │ ┌───────────── hour (0 - 23)
      #      │ │ ┌───────────── day of the month (1 - 31)
      #      │ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
      #      │ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
      #      │ │ │ │ │
    - cron: '1 2 3 * *'  # run at 2:01 every month on the 3rd day

jobs:
  test:
    strategy:
      fail-fast: false
      matrix:
        os: [ 'ubuntu-24.04', 'ubuntu-22.04' ]
        python: [ '3.12', '3.11', '3.10', '3.9','3.8' ]

    runs-on: ${{ matrix.os }}
    name: Python ${{ matrix.python }} on ${{ matrix.os }}

    steps:
      - name: Checkout the repo
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python }}
          cache: 'pip'

      - name: Update pip
        run: python -m pip install --upgrade pip

      - name: Install Python core deps (3.8 — 3.11)
        run: python -m pip install -r requirements.txt
        if: ${{ matrix.python != '3.12' }}

      - name: Install Python testing deps (3.8 — 3.11)
        run: python -m pip install -r requirements-test.txt
        if: ${{ matrix.python != '3.12' }}

      - name: Install Python core deps (3.12)
        run: python -m pip install -r requirements-3.12.txt
        if: ${{ matrix.python == '3.12' }}

      - name: Install Python testing deps (3.12)
        run: python -m pip install -r requirements-3.12-test.txt
        if: ${{ matrix.python == '3.12' }}

      - name: Run Python tests
        run: make py-test VERBOSE=1

      - name: Check types with Mypy
        run: make mypy-test PYTHON_VERSION=${{ matrix.python }} VERBOSE=1

      - name: Check types with PyType
        run: make pytype-test PYTHON_VERSION=${{ matrix.python }} VERBOSE=1
        # https://github.com/google/pytype/issues/1475
        #
        # PyType does not yet support Python 3.12; if this step is enabled, it
        # fails with an error: "Python versions > 3.11 are not yet supported."
        if: ${{ matrix.python != '3.12' }}

      - name: Run nbconvert test
        run: make nbconvert-test

      - name: Run notebook format test
        run: make nbfmt-test

      - name: Run datasets test
        run: make datasets-test

      - name: Install tools for building SVG diagrams
        run: |
          sudo apt update
          sudo apt install graphviz m4

      - name: Build GoogLeNet SVG diagrams
        run: |
          cd googlenet/diagrams
          # The SVG files are checked-in for convenience; delete them to force
          # `make` to regenerate them, so we're not depending on timestamps.
          rm -f *.svg
          make all VERBOSE=1