chore(ci): refactor Makefile and CI to unify quality checks via make check

.github/workflows/ci.yml

@@ -15,44 +15,59 @@ jobs:
     permissions:
       contents: read
     env:
+      # App env (if your tests need them)
       PROXY_API_KEY: ${{ secrets.PROXY_API_KEY }}
       PROXY_BASE_URL: ${{ secrets.PROXY_BASE_URL }}
+      # Ensure imports work when running `pytest` via Makefile
+      PYTHONPATH: ${{ github.workspace }}
 
     steps:
-      - name: Checkout repository
+      - name: Checkout
         uses: actions/checkout@v4
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.12"
-          cache: "pip"
+          cache: pip
           cache-dependency-path: |
             requirements.txt
 
-      - name: Upgrade pip tooling
-        run: python -m pip install --upgrade pip setuptools wheel
-
       - name: Install dependencies
         run: |
-          if [ -f requirements-dev.txt ]; then
-            pip install -r requirements-dev.txt
-          else
+            python -m pip install -U pip wheel
             pip install -r requirements.txt
-            python -m pip install ruff mypy pytest
-          fi
+            pip install ruff mypy pytest pytest-cov
 
-      - name: Check code formatting (ruff)
-        run: python -m ruff format --check .
+      # Optional caches for tool state (speed up CI on subsequent runs)
+      - name: Cache Ruff
+        uses: actions/cache@v4
+        with:
+          path: .ruff_cache
+          key: ruff-${{ runner.os }}-${{ hashFiles('**/*.py', 'pyproject.toml', 'ruff.toml', '.pre-commit-config.yaml') }}
 
-      - name: Lint (ruff)
-        run: python -m ruff check .
+      - name: Cache Mypy
+        uses: actions/cache@v4
+        with:
+          path: .mypy_cache
+          key: mypy-${{ runner.os }}-${{ hashFiles('**/*.py', 'mypy.ini', 'pyproject.toml') }}
 
-      - name: Type check (mypy)
-        run: python -m mypy . --ignore-missing-imports --explicit-package-bases
+      - name: Cache Pytest
+        uses: actions/cache@v4
+        with:
+          path: .pytest_cache
+          key: pytest-${{ runner.os }}-${{ hashFiles('**/*.py', 'pyproject.toml') }}
 
-      - name: Run tests
-        run: python -m pytest -q
+      - name: Quality gate (format check, lint, typecheck, tests)
+        run: make check
+
+      - name: Upload coverage (optional)
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: ./.coverage
+          if-no-files-found: ignore
 
   docker-build:
     needs: build-test
@@ -67,30 +82,34 @@ jobs:
       IMAGE_NAME: nl2sql-copilot
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-      - name: Login to GHCR (via GITHUB_TOKEN)
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GHCR
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Compute image refs (lowercased owner)
+      - name: Compute image refs
         run: |
           OWNER_LC=$(echo "${{ github.repository_owner }}" | tr '[:upper:]' '[:lower:]')
           echo "OWNER_LC=$OWNER_LC" >> $GITHUB_ENV
           echo "IMAGE=${{ env.REGISTRY }}/${OWNER_LC}/${{ env.IMAGE_NAME }}:${{ github.sha }}" >> $GITHUB_ENV
           echo "LATEST=${{ env.REGISTRY }}/${OWNER_LC}/${{ env.IMAGE_NAME }}:latest" >> $GITHUB_ENV
 
-      - name: Build image
-        run: docker build -t "$IMAGE" .
-
-      - name: Push image (commit SHA tag)
-        run: docker push "$IMAGE"
-
-      - name: Tag 'latest' and push
-        run: |
-          docker tag "$IMAGE" "$LATEST"
-          docker push "$LATEST"
+      - name: Build and push (with cache)
+        uses: docker/build-push-action@v6
+        with:
+          push: true
+          tags: |
+            ${{ env.IMAGE }}
+            ${{ env.LATEST }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Makefile

@@ -31,35 +31,51 @@ install: ## Install runtime dependencies inside venv
 .PHONY: dev-install
 dev-install: ## Install dev tools (ruff, mypy, pytest, coverage, uvicorn, etc.)
 	$(PIP) install -U pip wheel
-	$(PIP) install ruff mypy pytest pytest-cov uvicorn
+	$(PIP) install ruff mypy pytest pytest-cov uvicorn pre-commit
 
 .PHONY: bootstrap
 bootstrap: venv dev-install ## Create venv and install dev tools
 
-# ---------- Quality ----------
-.PHONY: format
-format: ## Auto-format & fix with ruff
-	$(RUFF) format .
-	$(RUFF) check . --fix
+# ---------- Quality (read-only for CI) ----------
+.PHONY: fmt-check
+fmt-check: ## Verify formatting without modifying files
+	$(RUFF) format . --check
 
 .PHONY: lint
-lint: ## Run linting and type checking
+lint: ## Run linting
 	$(RUFF) check .
-	$(MYPY) .
 
 .PHONY: typecheck
 typecheck: ## Run type checking only
-	$(MYPY) .
+	$(MYPY) . --ignore-missing-imports --explicit-package-bases
+
+# ---------- Quality (write mode for local dev) ----------
+.PHONY: format
+format: ## Auto-format & fix with ruff
+	$(RUFF) format .
+	$(RUFF) check . --fix
 
 # ---------- Tests ----------
 .PHONY: test
-test: ## Run pytest quietly
+test: ## Run fast test suite (exclude slow)
+	PYTHONPATH=$$PWD $(PYTEST) -q -m "not slow"
+
+.PHONY: test-all
+test-all: ## Run full test suite including slow tests
 	PYTHONPATH=$$PWD $(PYTEST) -q
 
 .PHONY: cov
 cov: ## Run tests with coverage
 	PYTHONPATH=$$PWD $(PYTEST) --cov=nl2sql --cov-report=term-missing
 
+# ---------- Unified gate for CI ----------
+.PHONY: check
+check: ## Run format check, lint, typecheck, and fast tests
+	make fmt-check
+	make lint
+	make typecheck
+	make test
+
 # ---------- Pre-commit ----------
 .PHONY: precommit
 precommit: ## Run all pre-commit hooks on all files
@@ -87,7 +103,7 @@ docker-run: ## Run Docker container on port $(PORT)
 # ---------- Clean ----------
 .PHONY: clean
 clean: ## Remove Python caches
-	rm -rf __pycache__ .pytest_cache .mypy_cache
+	rm -rf __pycache__ .pytest_cache .mypy_cache .ruff_cache
 
 .PHONY: clean-all
 clean-all: clean ## Remove build artifacts and coverage