extralit.yml

name: Build Extralit Package & Publish

concurrency:
  group: ${{ github.workflow }}-${{ github.sha }}
  cancel-in-progress: true

on:
  workflow_dispatch:

  push:
    branches:
      - main
      - develop
      - releases/**
    paths:
      - "extralit/**"
      - ".github/workflows/extralit.yml"

  pull_request:
    paths:
      - "extralit/**"
      - ".github/workflows/extralit.yml"

permissions:
  id-token: write
  contents: write

jobs:
  build:
    if: github.event.pull_request.draft == false
    services:
      extralit-container:
        image: extralitdev/extralit-hf-space:latest
        ports:
          - 6900:6900
        env:
          HF_HUB_DISABLE_TELEMETRY: 1
          # Set credentials
          USERNAME: extralit
          PASSWORD: 12345678
          API_KEY: extralit.apikey
    runs-on: ubuntu-22.04
    defaults:
      run:
        working-directory: extralit
    strategy:
      fail-fast: true
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
    steps:
      - uses: actions/checkout@v4
      - name: Install uv
        uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86
        with:
          pyproject-file: "extralit/pyproject.toml"
          python-version: ${{ matrix.python-version }}
          enable-cache: true
          cache-local-path: ~/.cache/uv
          ignore-nothing-to-cache: true
          cache-dependency-glob: "extralit/uv.lock"
      - name: Install dependencies
        run: |
          uv sync
          uv cache prune --ci
      - name: Wait for extralit-container to start
        timeout-minutes: 3
        run: |
          echo "Waiting for services to start..."
          # Start streaming logs in background
          docker logs -f ${{ job.services.extralit-container.id }} &
          LOGS_PID=$!
          # Wait for the service to be ready
          while ! curl -s -o /dev/null -XGET http://localhost:6900/api/v1/status; do sleep 10; done
          echo "✅ Services are ready!"
          # Stop log streaming
          kill $LOGS_PID || true

      - name: Set huggingface hub credentials
        run: |
          echo "HF_TOKEN_EXTRALIT_INTERNAL_TESTING=${{ secrets.HF_TOKEN_EXTRALIT_INTERNAL_TESTING }}" >> "$GITHUB_ENV"
          echo "Enable HF access token"
      - name: Run unit tests
        id: tests-unit
        continue-on-error: true
        env:
          EXTRALIT_API_URL: http://localhost:6900
          EXTRALIT_API_KEY: extralit.apikey
        run: |
          uv run pytest tests/unit --disable-warnings --cov=extralit --cov-report=term --cov-report=xml

      - name: Check test status
        if: steps.tests-unit.outcome == 'failure'
        run: exit 1

      - name: Run integration tests
        id: tests-integration
        continue-on-error: true
        env:
          EXTRALIT_API_URL: http://localhost:6900
          EXTRALIT_API_KEY: extralit.apikey
        run: |
          uv run pytest tests/integration --disable-warnings --cov=extralit --cov-report=term --cov-report=xml --cov-append

      - name: Generate coverage report
        if: always()
        continue-on-error: true
        run: |
          uv run coverage xml -o coverage.xml
          uv run coverage report

      - name: Upload test coverage
        if: always()
        uses: codecov/codecov-action@v5.4.3
        with:
          files: coverage.xml
          flags: extralit
          token: ${{ secrets.CODECOV_TOKEN }}
          fail_ci_if_error: false

      - name: Check test status
        if: steps.tests-integration.outcome == 'failure'
        run: exit 1

      - name: Build package
        run: |
          uv build
      - name: Upload artifact
        uses: actions/upload-artifact@v4
        # Upload the package to be used in the next jobs only once
        if: ${{ matrix.python-version == '3.9' }}
        with:
          name: extralit
          path: extralit/dist

  # This job will publish extralit package into PyPI repository
  publish_release:
    name: Publish Release
    runs-on: ubuntu-latest
    if: ${{ github.ref == 'refs/heads/main' || github.event_name == 'workflow_dispatch' }}

    permissions:
      # This permission is needed for private repositories.
      # contents: read
      # IMPORTANT: this permission is mandatory for trusted publishing on PyPI
      id-token: write

    needs:
      - build

    defaults:
      run:
        shell: bash -l {0}
        working-directory: extralit

    steps:
      - name: Checkout Code 🛎
        uses: actions/checkout@v4

      - name: Update repo visualizer
        uses: githubocto/repo-visualizer@0.7.1
        with:
          root_path: "extralit/"
          excluded_paths: "dist,build,node_modules,docs,tests,.swm,assets,.github,package-lock.json,uv.lock"
          excluded_globs: "*.spec.js;**/*.{png,jpg,svg,md};**/!(*.module).ts,**/__pycache__/,**/__mocks__/,LICENSE*,**/.gitignore,**/*.egg-info/,**/.*/"
          output_file: "repo-visualizer.svg"
          should_push: false

      - name: Upload repo visualizer diagram as artifact
        uses: actions/upload-artifact@v4
        with:
          name: repo-visualizer
          path: repo-visualizer.svg
          retention-days: 10

      - name: Download python package
        uses: actions/download-artifact@v4
        with:
          name: extralit
          path: extralit/dist

      - name: Install uv
        uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86
        with:
          pyproject-file: "extralit/pyproject.toml"
          python-version: "3.9"

      - name: Read package info
        run: |
          PACKAGE_VERSION=$(grep '__version__' src/extralit/_version.py | cut -d'"' -f2)
          PACKAGE_NAME="extralit"
          echo "PACKAGE_VERSION=$PACKAGE_VERSION" >> $GITHUB_ENV
          echo "PACKAGE_NAME=$PACKAGE_NAME" >> $GITHUB_ENV
          echo "$PACKAGE_NAME==$PACKAGE_VERSION"

      - name: Publish Package to PyPI test environment 🥪
        continue-on-error: true
        run: |
          uv publish --index-url https://test.pypi.org/legacy/ --token ${{ secrets.AR_TEST_PYPI_API_TOKEN }} dist/*

      - name: Test Installing 🍿
        continue-on-error: true
        run: |
          pip3 install --index-url https://test.pypi.org/simple --no-deps  $PACKAGE_NAME==$PACKAGE_VERSION

      - name: Publish Package to PyPI 🥩
        if: github.ref == 'refs/heads/main'
        run: |
          uv publish --token ${{ secrets.AR_PYPI_API_TOKEN }} dist/*