ci.yml

name: CI

on:
  push:

jobs:
  python-build:
    name: 🏗️ Build Python wheels
    strategy:
      matrix:
        python:
        - '3.8'
        - '3.9'
        - '3.10'
        - '3.11'
        - '3.12'
    runs-on: ubuntu-latest
    steps:
    - name: 📥 Check-out
      uses: actions/checkout@v4
    - name: 🧰 Install Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python }}
        cache: pip
        cache-dependency-path: pyproject.toml
    - name: 🧰 Install dependencies
      run: pip install build twine
    - name: 🏗️ Build Python wheels
      run: python -m build
    - name: 🧪 Check package bundles
      run: twine check dist/*
    - name: 📤 Upload Python wheels
      uses: actions/upload-artifact@v4
      if: matrix.python == '3.12'
      with:
        name: wheels
        path: dist
  python-code-format:
    name: 🔍 Check Python code format
    strategy:
      matrix:
        python:
        - '3.8'
        - '3.9'
        - '3.10'
        - '3.11'
        - '3.12'
    runs-on: ubuntu-latest
    steps:
    - name: 📥 Check-out
      uses: actions/checkout@v4
    - name: 🧰 Install Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python }}
        cache: pip
        cache-dependency-path: pyproject.toml
    - name: 🧰 Install dependencies
      run: pip install .[test]
    - name: 🔍 Check Python code format
      run: flake8 chatnoir_pyterrier tests examples
  python-lint:
    name: 🔍 Lint Python code
    strategy:
      matrix:
        python:
        - '3.8'
        - '3.9'
        - '3.10'
        - '3.11'
        - '3.12'
    runs-on: ubuntu-latest
    steps:
    - name: 📥 Check-out
      uses: actions/checkout@v4
    - name: 🧰 Install Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python }}
        cache: pip
        cache-dependency-path: pyproject.toml
    - name: 🧰 Install dependencies
      run: pip install .[test]
    - name: 🔍 Lint Python code
      run: pylint -E chatnoir_pyterrier tests examples
  python-test:
    name: 🧪 Test Python code
    strategy:
      matrix:
        python:
        #- '3.8'
        #- '3.9'
        #- '3.10'
        #- '3.11'
        - '3.12'
    runs-on: ubuntu-latest
    steps:
    - name: 📥 Check-out
      uses: actions/checkout@v4
    - name: 🧰 Install Python
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python }}
        cache: pip
        cache-dependency-path: pyproject.toml
    - name: 🧰 Install dependencies
      run: pip install .[test]
    - name: 🧪 Test Python code
      env:
        CHATNOIR_API_KEY: ${{ secrets.CHATNOIR_API_KEY }}
        CHATNOIR_API_KEY_STAGING: ${{ secrets.CHATNOIR_API_KEY_STAGING }}
      run: pytest --cov --cov-report=xml chatnoir_pyterrier tests examples
    - name: 📤 Upload coverage to Codecov
      uses: codecov/codecov-action@v4
      if: matrix.python == '3.12'
      with:
        token: ${{ secrets.CODECOV_TOKEN }}
  python-publish:
    name: 🚀 Publish Python wheels
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
    needs:
    - python-build
    - python-code-format
    - python-lint
    - python-test
    runs-on: ubuntu-latest
    permissions:
      id-token: write
    steps:
    - name: 📥 Check-out
      uses: actions/checkout@v4
    - name: 📥 Download Python wheels
      uses: actions/download-artifact@v4
      with:
        name: wheels
        path: dist
    - name: 🚀 Publish Python wheels
      uses: pypa/gh-action-pypi-publish@release/v1
  github-release:
    name: 🚀 Create GitHub release
    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
    needs:
    - python-build
    - python-code-format
    - python-lint
    - python-test
    runs-on: ubuntu-latest
    steps:
    - name: 📥 Check-out
      uses: actions/checkout@v4
    - name: 📥 Download Python wheels
      uses: actions/download-artifact@v4
      with:
        name: wheels
        path: dist
    - name: 🚀 Create GitHub release
      uses: softprops/action-gh-release@v2
      with:
        name: Release ${{ github.ref_name }}
        files: dist/*
        fail_on_unmatched_files: true
        draft: false
        prerelease: false
        generate_release_notes: true