Skip to content

Commit 4b66647

Browse files
ArshVermaGitArshVermaGit
committed
feat: finalize CodeLens. production suite (Docker, CI/CD, Documentation)
- Complete 100% professional rebrand to 'CodeLens.' across all assets - Implement multi-stage, non-root Docker builds for production security - Establish 5-job unified GitHub Actions pipeline (Lint, Test, Validate, Docker, GHCR) - Rewrite README.md into a professional 12-section technical manual - Create CONTRIBUTING.md, CHANGELOG.md (v1.0 to v2.0), and MIT LICENSE - Standardize all configuration templates (.env.example, .dockerignore) - Add PyYAML dependency and verify with 155/155 passing tests
1 parent 9b07070 commit 4b66647

15 files changed

Lines changed: 679 additions & 220 deletions

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎.dockerignore‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Python Artifacts
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
*.so
6+
.Python
7+
*.egg-info/
8+
dist/
9+
build/
10+
*.egg
11+
MANIFEST
12+
13+
# Node.js / Dashboard (Exclude sources, only keep builds)
14+
node_modules/
15+
dashboard/node_modules/
16+
dashboard/src/
17+
dashboard/public/
18+
dashboard/tests/
19+
dashboard/*.json
20+
dashboard/*.config.js
21+
dashboard/*.config.ts
22+
23+
# Virtual Environment
24+
venv/
25+
.venv/
26+
env/
27+
28+
# Testing & Coverage
29+
tests/
30+
.pytest_cache/
31+
coverage.xml
32+
.coverage
33+
htmlcov/
34+
pytest.ini
35+
36+
# Git
37+
.git/
38+
.gitignore
39+
40+
# Environment & Private Files
41+
.env
42+
.env.*
43+
*.env.local
44+
.history/
45+
Roadmap.html
46+
47+
# Data Persistence (Ensures no local DB leaks into image)
48+
data/
49+
codelens.db
50+
*.sqlite3
51+
52+
# OS Specific
53+
.DS_Store
54+
.DS_Store?
55+
**/._*
56+
**/.DS_Store
57+
Thumbs.db
58+
ehthumbs.db
59+
60+
# IDEs
61+
.vscode/
62+
.idea/
63+
*.swp
64+
*.swo

‎.env.example‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
1-
# AgentOrg CodeReview — Environment Variables
1+
# CodeLens. — Configuration Template
22
# Copy this file to .env and fill in your values.
33

4-
# API Configuration
4+
# API Profile
55
APP_HOST=0.0.0.0
66
APP_PORT=7860
77
APP_ENV=development # development | production
8+
APP_PORT=7860
9+
10+
# Security (X-API-Key header)
11+
API_KEY=changeme
12+
API_KEY_ENABLED=false
13+
14+
# Persistence & State
15+
DATABASE_URL=sqlite+aiosqlite:///./data/codelens.db
16+
EPISODE_TTL=3600 # Auto-cleanup time in seconds (1hr)
817

9-
# Security
10-
API_KEY=changeme # Required in production; sent as X-API-Key header
11-
API_KEY_ENABLED=false # Set to true in production
18+
# Rate Limiting (Requests per minute)
19+
RATE_LIMIT_DEFAULT=60
1220

1321
# Leaderboard
14-
LEADERBOARD_MAX_ENTRIES=10 # Top-N entries to keep per task
22+
LEADERBOARD_LIMIT=10 # Default entries per task page
1523

1624
# Logging
1725
LOG_LEVEL=INFO # DEBUG | INFO | WARNING | ERROR

‎.github/workflows/ci.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop, "feat/**", "fix/**", "test/**", "docs/**" ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
# ── Job 1: Lint ────────────────────────────────────────────────
11+
lint:
12+
name: Lint
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/setup-python@v5
17+
with:
18+
python-version: "3.11"
19+
cache: pip
20+
- run: pip install pylint
21+
- run: pylint --fail-under=7 $(git ls-files '*.py') || true
22+
# Soft fail: warn but don't block on lint score
23+
24+
# ── Job 2: Test ────────────────────────────────────────────────
25+
test:
26+
name: Test (Python ${{ matrix.python-version }})
27+
runs-on: ubuntu-latest
28+
strategy:
29+
matrix:
30+
python-version: ["3.10", "3.11"]
31+
steps:
32+
- uses: actions/checkout@v4
33+
- uses: actions/setup-python@v5
34+
with:
35+
python-version: ${{ matrix.python-version }}
36+
cache: pip
37+
- name: Install dependencies
38+
run: pip install -r requirements.txt pytest pytest-cov
39+
- name: Run tests with coverage
40+
run: |
41+
PYTHONPATH=. python -m pytest tests/ -v \
42+
--cov=codelens_env \
43+
--cov=app \
44+
--cov-report=xml \
45+
--cov-report=term-missing \
46+
--tb=short
47+
env:
48+
APP_ENV: test
49+
- name: Upload coverage report
50+
uses: codecov/codecov-action@v4
51+
if: matrix.python-version == '3.11'
52+
with:
53+
file: ./coverage.xml
54+
fail_ci_if_error: false
55+
56+
# ── Job 3: Validate environment ────────────────────────────────
57+
validate:
58+
name: Validate All Scenarios
59+
runs-on: ubuntu-latest
60+
needs: test
61+
steps:
62+
- uses: actions/checkout@v4
63+
- uses: actions/setup-python@v5
64+
with:
65+
python-version: "3.11"
66+
cache: pip
67+
- run: pip install -r requirements.txt
68+
- name: Validate all scenarios reachable
69+
run: PYTHONPATH=. python scripts/validate.py
70+
71+
# ── Job 4: Docker build ────────────────────────────────────────
72+
docker-build:
73+
name: Docker Build
74+
runs-on: ubuntu-latest
75+
needs: test
76+
steps:
77+
- uses: actions/checkout@v4
78+
- uses: docker/setup-buildx-action@v3
79+
- name: Build Docker image
80+
uses: docker/build-push-action@v5
81+
with:
82+
context: .
83+
target: production
84+
push: false
85+
tags: codelens-env:ci-${{ github.sha }}
86+
cache-from: type=gha
87+
cache-to: type=gha,mode=max
88+
- name: Test container health
89+
run: |
90+
docker run -d --name test-container -p 7860:7860 codelens-env:ci-${{ github.sha }}
91+
sleep 10
92+
curl -f http://localhost:7860/health
93+
docker stop test-container
94+
95+
# ── Job 5: Publish (on main push only) ────────────────────────
96+
publish:
97+
name: Publish to GHCR
98+
runs-on: ubuntu-latest
99+
needs: [test, docker-build]
100+
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
101+
permissions:
102+
contents: read
103+
packages: write
104+
steps:
105+
- uses: actions/checkout@v4
106+
- uses: docker/setup-buildx-action@v3
107+
- uses: docker/login-action@v3
108+
with:
109+
registry: ghcr.io
110+
username: ${{ github.actor }}
111+
password: ${{ secrets.GITHUB_TOKEN }}
112+
- name: Build and push
113+
uses: docker/build-push-action@v5
114+
with:
115+
context: .
116+
target: production
117+
push: true
118+
tags: |
119+
ghcr.io/${{ github.repository }}:latest
120+
ghcr.io/${{ github.repository }}:${{ github.sha }}
121+
cache-from: type=gha
122+
cache-to: type=gha,mode=max

‎.github/workflows/pylint.yml‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented here.
4+
Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
5+
6+
## [2.0.0] - 2026-04-05
7+
8+
### Added
9+
- **Models**: Complete Pydantic v2 models (`TaskId`, `Action`, `Scenario`, `EpisodeResult`, etc.)
10+
- **Scenarios**: 30 synthetic PR scenarios (10 per task) with realistic Python diffs
11+
- **Env**: Full episode state machine with noise budget, reward calculation, and history tracking
12+
- **Graders**:
13+
- `bug_grader.py`: Coverage + precision + severity-weighted scoring
14+
- `security_grader.py`: Severity-accuracy-weighted scoring (CRITICAL misclassification penalized)
15+
- `arch_grader.py`: Binary issue detection + verdict scoring + detail quality bonus
16+
- **Config**: Pydantic-settings config with all options documented in `.env.example`
17+
- **Database**: SQLModel persistence (`EpisodeRecord`, `LeaderboardRecord`, helpers)
18+
- **API Endpoints**:
19+
- `GET /stats`: Aggregate metrics across all recorded episodes
20+
- `GET /episodes/{id}/replay`: Full action-by-action replay for completed episodes
21+
- `GET /episodes`: List active episodes with metadata
22+
- `GET /dashboard`: Web dashboard (dark theme, live leaderboard, WebSocket event feed, stats cards)
23+
- **Security**:
24+
- Rate limiting via `slowapi`: 60 req/min per IP (configurable)
25+
- API key authentication: optional, off by default, enabled via `API_KEY_ENABLED=true`
26+
- **Episode Lifecycle**: Auto-cleanup of expired episodes every 5 minutes (default 1hr)
27+
- **Leaderboard**: Paginated `/leaderboard?limit=N&offset=M&task_id=X`
28+
- **Baseline Agent**: Full rewrite with argparse CLI, `KeywordAgent` (35 rules), `LLMAgent` (Claude)
29+
- **Evaluation**: `scripts/evaluate.py` for batch evaluation of all 30 scenarios with summary report and progress bars
30+
- **Database Utility**: `scripts/migrate.py` for database init/reset commands
31+
- **Testing**:
32+
- `tests/conftest.py`: Shared fixtures with in-memory DB override
33+
- `tests/test_scenarios.py`: 30 parametrized scenario validation tests
34+
- `tests/test_database.py`: Persistence layer unit tests
35+
- **Dockerization**: Multi-stage `builder` + `production` builds with non-root user security
36+
- **CI/CD**: Unified 5-job pipeline (`lint`, `test`, `validate`, `docker-build`, `publish` to GHCR)
37+
- **Branding**: Full rebrand to **CodeLens.**, including signature typography and SVG iconography
38+
39+
### Fixed
40+
- **CLI**: Port mismatch in `baseline.py` (8000 → 7860) and added `--url`, `--task`, `--seed` CLI flags
41+
- **Crash Fixes**: Leaderboard submit crash after list slicing (captured rank before slice)
42+
- **WebSocket**: Disconnect now handled with typed `WebSocketDisconnect` and `clients.discard()`
43+
- **Metadata**: Incoherent weight structure in `codelens.yaml` replaced with named, accurate pairs
44+
45+
### Changed
46+
- **Response Format**: `/leaderboard` response format: each task now `{"entries": [...], "total": N}` (was bare list)
47+
- **Startup**: `app.py` startup initializes DB and logs confirmation message
48+
49+
## [1.0.0] - Original Fork Baseline
50+
51+
### Added
52+
- FastAPI skeleton with /reset, /step, /result, /leaderboard, /submit endpoints
53+
- In-memory episode storage
54+
- WebSocket event broadcasting at /ws/events
55+
- Basic Dockerfile
56+
- Pylint-only GitHub Actions workflow
57+
- codelens.yaml placeholder
58+
- README with roadmap

0 commit comments

Comments
 (0)