github-actions.yml

name: MongoengineCI
on:
  # All PR
  pull_request:
  # master branch merge
  push:
    branches:
      - master
  # Manual trigger from Action page
  workflow_dispatch:
  # release tags
  create:
    tags:
      - 'v[0-9]+\.[0-9]+\.[0-9]+*'
env:
  MONGODB_4_4: "4.4.29"
  MONGODB_5_0: "5.0.31"
  MONGODB_6_0: "6.0.22"
  MONGODB_7_0: "7.0.19"
  MONGODB_8_0: "8.0.9"

  PYMONGO_4_8:  "4.8.0"
  PYMONGO_4_10: "4.10.1"
  PYMONGO_4_14: "4.14.1"
  PYMONGO_4_15: "4.15.5"
  PYMONGO_4_16: "4.16.0"
  PYMONGO_4_17: "4.17.0"

  MAIN_PYTHON_VERSION: "3.14"
  MAIN_MONGODB_VERSION: $MONGODB_8_0
  MAIN_PYMONGO_VERSION: $PYMONGO_4_17

jobs:
  linting:
    # Run pre-commit (https://pre-commit.com/)
    # which runs pre-configured linter & autoformatter
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
    - uses: actions/setup-python@v6
      with:
        python-version: ${{ env.MAIN_PYTHON_VERSION }}
        check-latest: true
    - run: bash .github/workflows/install_ci_python_dep.sh
    - run: pre-commit run -a

  test:
    # Test suite run against recent python versions
    # and against a few combination of MongoDB and pymongo
    runs-on: ubuntu-22.04
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "pypy3.10"]
        MONGODB: [$MONGODB_4_4]
        PYMONGO: [$PYMONGO_4_8]
        include:
          - python-version: "3.11"
            MONGODB: $MONGODB_5_0
            PYMONGO: $PYMONGO_4_10
          - python-version: "3.12"
            MONGODB: $MONGODB_6_0
            PYMONGO: $PYMONGO_4_14
          - python-version: "3.13"
            MONGODB: $MONGODB_7_0
            PYMONGO: $PYMONGO_4_15
          - python-version: "3.13"
            MONGODB: $MONGODB_8_0
            PYMONGO: $PYMONGO_4_16
          - python-version: "3.14"
            MONGODB: $MONGODB_8_0
            PYMONGO: $PYMONGO_4_17
    steps:
    - uses: actions/checkout@v6
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ matrix.python-version }}
        check-latest: true
    - name: install mongo and ci dependencies
      run: |
        bash .github/workflows/install_mongo.sh ${{ matrix.MONGODB }}
        bash .github/workflows/install_ci_python_dep.sh
        bash .github/workflows/start_mongo.sh ${{ matrix.MONGODB }}
    - name: tox dry-run (to pre-install venv)
      run: tox -e $(echo py${{ matrix.python-version }}-mg${{ matrix.PYMONGO }} | tr -d . | sed -e 's/pypypy/pypy/') -- "-k=test_ci_placeholder"
    - name: Run test suite
      run: tox -e $(echo py${{ matrix.python-version }}-mg${{ matrix.PYMONGO }} | tr -d . | sed -e 's/pypypy/pypy/') -- "--cov=mongoengine"
    - name: Send coverage to Coveralls
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        COVERALLS_SERVICE_NAME: github-actions
      if: >-
        ${{
          matrix.python-version == env.MAIN_PYTHON_VERSION &&
          matrix.MONGODB == env.MAIN_MONGODB_VERSION &&
          matrix.PYMONGO == env.MAIN_PYMONGO_VERSION
        }}
      run: coveralls

  build_doc_dryrun:
    # ensures that readthedocs can be built continuously
    # to avoid that it breaks when new releases are being created
    # The way RTD works is that it builds the doc on its side
    # builds are visible at https://readthedocs.org/projects/mongoengine-odm/builds/
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
    - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ env.MAIN_PYTHON_VERSION }}
        check-latest: true
    - name: install python dep
      run: |
        python -m pip install --upgrade --no-cache-dir pip setuptools
        python -m pip install --upgrade --no-cache-dir sphinx
        python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
        python -m pip install --no-cache-dir .
    - name: build doc
      run: |
        cd docs
        make html-readthedocs

  build-dryrun:
    runs-on: ubuntu-latest
    needs: [linting, test, build_doc_dryrun]
    steps:
    - uses: actions/checkout@v6
    - uses: actions/setup-python@v6
      with:
        python-version: ${{ env.MAIN_PYTHON_VERSION }}
        check-latest: true
    - name: build dummy wheel for test-pypi
      run: |
        pip install setuptools wheel
        python setup.py sdist bdist_wheel

  build-n-publish:
    runs-on: ubuntu-latest
    needs: [linting, test, build_doc_dryrun, build-dryrun]
    if: github.event_name == 'create' && startsWith(github.ref, 'refs/tags/v')
    steps:
    - uses: actions/checkout@v6
    - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
      uses: actions/setup-python@v6
      with:
        python-version: ${{ env.MAIN_PYTHON_VERSION }}
        check-latest: true
    # todo separate build from publish
    # https://stackoverflow.com/questions/59349905/which-properties-does-github-event-in-a-github-workflow-have
    - name: build dummy wheel for test-pypi
      run: |
        pip install setuptools wheel
        python setup.py sdist bdist_wheel
    - name: publish pypi
      uses: pypa/gh-action-pypi-publish@release/v1
      with:
        password: ${{ secrets.pypi_token }}