docs: list compat make targets#1914
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
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
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_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
All checks passed!
uvx ruff format --check ./aperag ./tests
555 files already formatted
Part of SRE task #15 infrastructure cleanup.