build_lint.yml

name: build

on:
  push:
    branches:
    - main
    - release**
    paths-ignore:
      - '**.md'
      - '**.rst'
  pull_request:
    paths-ignore:
      - '**.md'
      - '**.rst'

# This will cancel previous run if a newer job that obsoletes the said previous
# run, is started.
# Based on https://github.com/zulip/zulip/commit/4a11642cee3c8aec976d305d51a86e60e5d70522
concurrency:
  group: "${{ github.workflow }}-${{ github.head_ref || github.run_id }}"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ${{ matrix.os }}-latest
    # We need an explicit timeout because sometimes the batch_runner test never
    # completes.
    timeout-minutes: 6
    strategy:
      fail-fast: False
      matrix:
        os: [windows, ubuntu, macos]
        python-version: ["3.12"]
        include:
          - os: ubuntu
            python-version: "3.11"
          - os: ubuntu
            python-version: "3.10"
          - os: ubuntu
            python-version: "3.9"
          # Disabled for now. See https://github.com/projectmesa/mesa/issues/1253
          #- os: ubuntu
          #  python-version: 'pypy-3.8'

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
    - if: ${{ runner.os == 'Windows' }}
      # This is needed so that restoring cache on Windows is fast.
      # See until https://github.com/actions/cache/issues/752 is resolved.
      name: Use GNU tar
      shell: cmd
      run: |
        echo "Adding GNU tar to PATH"
        echo C:\Program Files\Git\usr\bin>>"%GITHUB_PATH%"
    - uses: actions/cache@v4
      with:
        path: ${{ env.pythonLocation }}
        key: ${{ runner.os }}-pip-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}
    - name: Install dependencies
      # Only if the cache misses
      # Based on https://github.com/pypa/pip/issues/8049#issuecomment-633845028
      # read_requirements.py should be removed once
      # https://github.com/pypa/pip/issues/11440 is resolved.
      if: steps.cache.outputs.cache-hit != 'true'
      run: |
        pip install toml
        python tests/read_requirements.py > requirements.txt
        pip install -r requirements.txt
    - name: Install Mesa
      run: pip install --no-deps .
    - name: Test with pytest
      run: pytest --cov=mesa tests/ --cov-report=xml
    - if: matrix.os == 'ubuntu'
      name: Codecov
      uses: codecov/codecov-action@v3

  examples:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3.12"
    - uses: actions/cache@v4
      with:
        path: ${{ env.pythonLocation }}
        key: test-examples-pip-${{ env.pythonLocation }}-${{ hashFiles('setup.py') }}
    - name: Install dependencies
      # Only if the cache misses
      # Based on https://github.com/pypa/pip/issues/8049#issuecomment-633845028
      # read_requirements.py should be removed once
      # https://github.com/pypa/pip/issues/11440 is resolved.
      if: steps.cache.outputs.cache-hit != 'true'
      run: |
        pip install toml
        python tests/read_requirements.py > requirements.txt
        pip install -r requirements.txt
    - name: Install Mesa
      run: pip install --no-deps .
    - name: Checkout mesa-examples
      uses: actions/checkout@v4
      with:
        repository: projectmesa/mesa-examples
        path: mesa-examples
    - name: Test examples
      run: |
        cd mesa-examples
        pytest test_examples.py