gh-christianlouis-docuelevate/.github/workflows/ci.yml

name: CI Pipeline

on:
  push:
    branches:
      - main
      - develop
    tags:
      - 'v*'
      - '[0-9]+.*'
  pull_request:
    branches:
      - main

permissions:
  contents: read
  packages: write

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
  IMAGE_NAME: christianlouis/docuelevate

jobs:
  # ══════════════════════════════════════════════════════════════════════════
  # Stage 1: Ruff Lint & Format (runs first to catch style issues early)
  # ══════════════════════════════════════════════════════════════════════════

  lint:
    name: Ruff Lint & Format
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install Ruff
        run: pip install ruff

      - name: Show Ruff version (debug)
        run: ruff --version

      - name: Run Ruff Lint (check)
        # ruff check can --fix locally, but CI should only check (no modifications)
        run: ruff check app/ tests/

      - name: Run Ruff Format check
        # ruff format only supports --check; do not pass --fix here
        run: ruff format --check app/ tests/

  # ══════════════════════════════════════════════════════════════════════════
  # Stage 2a: Dependency Vulnerability Scan (runs in parallel with lint)
  # ══════════════════════════════════════════════════════════════════════════

  dependency-scan:
    name: Dependency Vulnerability Scan
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install pip-audit
        run: pip install pip-audit>=2.7.0

      - name: Run pip-audit on production dependencies
        run: pip-audit -r requirements.txt --desc on

      - name: Run pip-audit on dev dependencies
        run: pip-audit -r requirements-dev.txt --desc on

  # ══════════════════════════════════════════════════════════════════════════
  # Stage 2b: Tests & Type Checking (run in parallel after lint passes)
  # ══════════════════════════════════════════════════════════════════════════

  test:
    name: Tests
    runs-on: ubuntu-latest
    needs: [lint, dependency-scan]  # Wait for lint and dependency scan before running tests
    services:
      redis:
        image: redis:7
        ports:
          - 6379:6379
        options: >-
          --health-cmd "redis-cli ping"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
      rabbitmq:
        image: rabbitmq:3-management
        ports:
          - 5672:5672
          - 15672:15672
        options: >-
          --health-cmd "rabbitmq-diagnostics -q ping"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements-dev.txt

      - name: Run Tests
        run: pytest tests/ -v --cov=app --cov-report=xml --cov-report=term --junitxml=junit.xml -o junit_family=legacy -m "not e2e"

      - name: Upload coverage reports to Codecov
        if: ${{ !cancelled() }}
        uses: codecov/codecov-action@v5
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: ./coverage.xml
          fail_ci_if_error: false

      - name: Upload test results to Codecov
        if: ${{ !cancelled() }}
        uses: codecov/codecov-action@v5
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: ./junit.xml
          report_type: test_results
          fail_ci_if_error: false

      - name: Upload test artifacts
        if: ${{ !cancelled() }}
        uses: actions/upload-artifact@v4
        with:
          name: test-results
          path: |
            junit.xml
            coverage.xml

  mypy:
    name: Mypy
    runs-on: ubuntu-latest
    needs: [lint, dependency-scan]  # Wait for lint and dependency scan before running type checks
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install Dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements-dev.txt

      - name: Run Mypy
        run: mypy app/

  # ══════════════════════════════════════════════════════════════════════════
  # Stage 3: Build & Push Docker Image (only after all Stage 2 jobs pass)
  # ══════════════════════════════════════════════════════════════════════════

  build:
    name: Build & Push Docker Image
    runs-on: ubuntu-latest
    needs: [test, lint, mypy, dependency-scan]
    if: github.event_name == 'push'

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

      - name: Generate Build Metadata
        run: |
          chmod +x scripts/generate_build_metadata.sh
          ./scripts/generate_build_metadata.sh

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Log in to Docker Hub
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USERNAME }}
          password: ${{ secrets.DOCKER_PASSWORD }}

      - name: Log in to GitHub Container Registry
        uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Extract metadata for tags
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: |
            ${{ env.IMAGE_NAME }}
            ghcr.io/${{ github.repository_owner }}/docuelevate
          tags: |
            type=ref,event=branch
            type=sha,prefix={{branch}}-
            type=semver,pattern={{version}}
            type=semver,pattern={{major}}.{{minor}}
            type=raw,value=latest,enable={{is_default_branch}}

      - name: Build and Push Docker Image
        uses: docker/build-push-action@v6
        with:
          context: .
          file: Dockerfile
          platforms: linux/amd64
          push: true
          sbom: true
          provenance: mode=max
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          cache-from: type=gha
          cache-to: type=gha,mode=max

  # ══════════════════════════════════════════════════════════════════════════
  # Stage 4: Update preprod K8s manifest (ArgoCD GitOps, only on main)
  # ══════════════════════════════════════════════════════════════════════════

  update-k8s-manifest:
    name: Update Preprod K8s Manifest
    runs-on: ubuntu-latest
    needs: [build]
    if: github.ref == 'refs/heads/main' && github.event_name == 'push'

    steps:
      - name: Compute image tag
        id: tag
        run: |
          SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
          echo "image=ghcr.io/${{ github.repository_owner }}/docuelevate:main-${SHORT_SHA}" >> "$GITHUB_OUTPUT"
          echo "tag=main-${SHORT_SHA}" >> "$GITHUB_OUTPUT"

      - name: Checkout k8s-cluster-state
        uses: actions/checkout@v4
        with:
          repository: christianlouis/k8s-cluster-state
          token: ${{ secrets.GH_PAT }}
          path: k8s-cluster-state

      - name: Update image tag in preprod manifest
        uses: mikefarah/yq@v4.44.6
        env:
          IMAGE: ${{ steps.tag.outputs.image }}
        with:
          cmd: |
            yq -i '(.. | select(tag == "!!str") | select(test("^(ghcr\\.io/christianlouis/docuelevate|christianlouis/docuelevate):"))) = strenv(IMAGE)' \
              k8s-cluster-state/apps/docuelevate/preprod/docuelevate-stack.yaml

      - name: Commit and push
        run: |
          cd k8s-cluster-state
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add apps/docuelevate/preprod/docuelevate-stack.yaml
          if git diff --staged --quiet; then
            echo "No changes to commit -- image tag already up to date"
          else
            git commit -m "chore(preprod): update docuelevate image to ${{ steps.tag.outputs.tag }}"
            git push
          fi