Implement Makefile for Development Automation

[haroon0x]

Issue: Implement Makefile for Development Automation

Problem Description

Following the standard patterns found in core Kubeflow repositories like pipelines and trainer, the docs-agent repository currently lacks a centralized automation tool for common development tasks.

Developers have to manually run various commands for:

• Building Docker images for the server.
• Compiling Kubeflow Pipelines.
• Running unit and E2E tests.
• Linting and formatting code.

This lack of automation increases the barrier for new contributors and leads to inconsistent development workflows.

Proposed Solution

Implement a root-level Makefile that provides a standardized interface for common tasks.

Target Commands to Implement:

• make build: Builds both the server and server-https Docker images.
• make compile: Compiles the pipelines/kubeflow-pipeline.py into a .yaml file.
• make test: Runs all tests (using pytest once standardized).
• make lint: Runs code quality checks (flake8, black, etc.).
• make clean: Removes temporary build artifacts and __pycache__ files.

Checklist

• Create a Makefile in the repository root.
• Implement build target for Docker images.
• Implement compile target for KFP components.
• Implement test and lint placeholders or targets.
• Document the use of make in the README.md development section.

[Bikram-ghuku]

Hi is this issue avaiable for taking up?

[haroon0x]

@Bikram-ghuku Sure you can start working on it.

[MayankJha0333]

@haroon0x I have added a few extras: make help for a quick command reference, and separate build/compile targets so you can run only what you need.

[saurabhhhcodes]

I'd love to take this on! Standardizing the development workflow with a Makefile is a great idea. I'll get started on this right away. Please assign it to me.

[ZaidAli3642]

Hi, I've submitted PR #179 that adds a Docker Compose setup for local development which covers some of these goals:

• Build: docker-compose up --build builds and starts all services (Milvus + API server)
• Clean: docker-compose down -v stops services and removes data
• Local ingestion: docker exec docs-agent-api python local_ingest.py replicates the KFP pipeline locally
• Environment config: .env.example template for all required variables
• A Makefile could complement this by wrapping the docker-compose commands and adding:

Compile: Compile KFP pipelines to YAML

• Test: Run tests via pytest
• Lint: Code quality checks (flake8, black)

Happy to discuss how these could work together.