Skip to content

docs: list compat make targets#1914

Merged
earayu merged 1 commit into
mainfrom
planetegg/make-help-compat
Apr 29, 2026
Merged

docs: list compat make targets#1914
earayu merged 1 commit into
mainfrom
planetegg/make-help-compat

Conversation

@earayu

@earayu earayu commented Apr 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • list graph/vector compatibility Make targets in
    ApeRAG Make Targets

Recommended commands:

Environment
make env-install Install Python dependencies into .venv
make env-dev Prepare the local development environment
make env-clean Clean local development state

Database / Infra
make db-migrate Apply database migrations
make db-check Verify schema matches SQLAlchemy models (no pending diff)
make db-revision Create a new alembic migration
make db-stamp-init One-off (PR #1859 cutover): reset alembic_version to the new init revision
make infra-up Start infra dependencies only
make stack-up Start the full local stack
make stack-down Stop the local stack
make stack-logs Tail stack logs

Services
make serve-api Run backend API locally
make serve-worker Run indexing worker locally
make serve-web Run frontend locally

Tests
make test-all Run unit + integration + pytest E2E suites
make test-unit Run unit tests
make test-integration Run integration tests
make test-e2e Run pytest-based residual E2E tests
make test-e2e-perf Run pytest-based E2E performance tests
make test-compat-graph Run graph-store compatibility tests (PG + optional Neo4j/Nebula)
make test-compat-vector Run vector-store compatibility tests (Qdrant + pgvector)
make test-compat-all Run graph + vector compatibility tests
make test-http-bootstrap Prepare HTTP E2E bootstrap state
make test-http-smoke Run HTTP smoke suite against an existing target
make test-http-full Run full HTTP suite against an existing target
make test-http-up-compose / test-http-down-compose
make test-http-smoke-compose / test-http-full-compose
make test-http-smoke-compose-{lite,qdrant-neo4j,qdrant-nebula} (per-shape shortcuts)
make test-http-full-compose-{lite,qdrant-neo4j,qdrant-nebula} (provider-aware per-shape shortcuts)
make test-http-up-k8s / test-http-down-k8s
make test-http-smoke-k8s / test-http-full-k8s
make benchmark-graph-extraction Run manual OpenRouter KG extraction benchmark

Build / API
make openapi-generate Export code-first OpenAPI specs
make openapi-check Verify code-first OpenAPI export
make build Build production images
make release-version Generate version metadata

Validation

  • ApeRAG Make Targets
    make test-compat-graph Run graph-store compatibility tests (PG + optional Neo4j/Nebula)
    make test-compat-vector Run vector-store compatibility tests (Qdrant + pgvector)
    make test-compat-all Run graph + vector compatibility tests
  • COMPAT_PG_URL=${COMPAT_PG_URL:-postgresql+asyncpg://postgres:postgres@127.0.0.1:5432/postgres}
    COMPAT_NEO4J_URI=${COMPAT_NEO4J_URI:-}
    COMPAT_NEO4J_USER=${COMPAT_NEO4J_USER:-neo4j}
    COMPAT_NEO4J_PASS=${COMPAT_NEO4J_PASS:-password}
    COMPAT_NEBULA_HOSTS=${COMPAT_NEBULA_HOSTS:-}
    uv run pytest
    tests/integration/compat/test_lineage_graph_compat.py
    -v
    COMPAT_QDRANT_URL=${COMPAT_QDRANT_URL:-http://127.0.0.1:6333}
    COMPAT_PGVECTOR_URL=${COMPAT_PGVECTOR_URL:-postgresql://postgres:postgres@127.0.0.1:5432/postgres}
    uv run pytest tests/integration/compat/test_vector_compat.py -v
  • pre-commit uvx ruff check --no-fix ./aperag ./tests
    All checks passed!
    uvx ruff format --check ./aperag ./tests
    555 files already formatted

Part of SRE task #15 infrastructure cleanup.

@earayu earayu merged commit 1f267bf into main Apr 29, 2026
9 of 10 checks passed
@earayu earayu deleted the planetegg/make-help-compat branch April 29, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant