ci.yml

name: CI

on:
  push:
    branches: [main, v1]
  pull_request:
    branches: [main, v1]
  schedule:
    - cron: "0 5 * * 1" # every monday at 05:00 UTC
  workflow_dispatch:

jobs:
  build:
    name: Python ${{ matrix.python-version }} ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12"]
        os: [ubuntu-latest]

    defaults:
      run:
        shell: bash -elo pipefail {0}

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

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

      - name: Install OSMnx
        run: |
          python -m pip install -r ./environments/tests/requirements-ci.txt
          python -m pip install -e .
          python -m pip list -v
          python -m pip show osmnx
          python --version

      - name: Cache pre-commit
        uses: actions/cache@v4
        with:
          path: ~/.cache/pre-commit/
          key: pre-commit-${{ matrix.os }}-${{ matrix.python-version }}-${{ hashFiles('.pre-commit-config.yaml') }}

      - name: Run pre-commit checks
        run: pre-commit run --all-files
        env:
          SKIP: no-commit-to-branch

      - name: Test docs build
        run: make -C ./docs html SPHINXOPTS="-E -W --keep-going"

      - name: Test code and coverage
        run: pytest --verbose --maxfail=1 --typeguard-packages=osmnx --cov=osmnx --cov-report=xml

      - name: Upload coverage report
        uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}