mirror of https://github.com/jeffusion/gitea-ai-assistant.git synced 2026-03-27 10:05:50 +00:00

Files

jeffusion 45e9b1f346 docs: rewrite README following open source standards with i18n

- Create English README.md as primary documentation
- Create Chinese docs/README.zh-CN.md with language link
- Focus on core functionality: features, quick start, configuration, deployment
- Remove CI badge, GitHub Actions, Contributing, Acknowledgments sections
- Remove verbose API Reference and Development sections
- Condense configuration examples for clarity
- Delete obsolete docs/ADMIN_UI_DESIGN.md

2026-03-03 16:49:19 +08:00

5.7 KiB

Raw Blame History

Gitea AI Assistant

AI-powered code review assistant for Gitea. Automatically reviews Pull Requests and commits using OpenAI, providing intelligent code quality analysis with both summary comments and line-level feedback.

中文文档

Features

🤖 AI Code Review - Automatic review of PRs and commits using OpenAI models
📝 Line-Level Comments - Precise feedback on specific code changes
🔄 Dual Review Engines - Legacy (simple) or Agent-based (multi-agent) review modes
🔔 Feishu Notifications - Integrated notification system for PR events
🎛️ Admin Dashboard - Web UI for managing repository webhooks and configuration
🔐 Secure Webhooks - HMAC-SHA256 signature verification

Architecture

┌─────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│   Gitea Server  │────▶│ Gitea Assistant  │────▶│   OpenAI API    │
│   (Webhooks)    │     │  (Hono + Bun)    │     │                 │
└─────────────────┘     └──────────────────┘     └─────────────────┘
                               │
                               ▼
                        ┌──────────────────┐
                        │  Admin Dashboard │
                        │   (React SPA)    │
                        └──────────────────┘

Review Engines

Engine	Description	Use Case
`legacy`	Single-pass AI review with summary + line comments	Simple, fast reviews
`agent`	Multi-agent orchestration with specialists, reflection, and debate	Deep, comprehensive analysis

Quick Start

Prerequisites

Bun >= 1.2.5
Gitea instance with API access
OpenAI API key

Installation

git clone https://github.com/user/gitea-ai-assistant.git
cd gitea-ai-assistant
bun install
cp .env.example .env

Configuration

Edit .env with your settings:

# Gitea
GITEA_API_URL=https://your-gitea-instance.com/api/v1
GITEA_ACCESS_TOKEN=your_gitea_token

# OpenAI
OPENAI_API_KEY=your_openai_key
OPENAI_MODEL=gpt-4o-mini

# Security
WEBHOOK_SECRET=your_webhook_secret  # openssl rand -hex 32

# Admin Dashboard
ADMIN_PASSWORD=your_admin_password

See Configuration Reference for all options.

Running

bun run dev    # Development mode
bun run start  # Production mode

Setting Up Webhooks

Option 1: Admin Dashboard (Recommended)

Access http://your-server:3000
Log in with ADMIN_PASSWORD
Click "Enable" on repositories to auto-configure webhooks

Option 2: Manual Configuration

In Gitea repository settings, add a webhook:

URL: http://your-server:3000/webhook/gitea
Content Type: application/json
Secret: Same as WEBHOOK_SECRET
Events: "Pull Request" and "Status"

Configuration Reference

Core Settings

Variable	Description	Default
`GITEA_API_URL`	Gitea API endpoint	Required
`GITEA_ACCESS_TOKEN`	Token for code review (read + comment permissions)	Required
`GITEA_ADMIN_TOKEN`	Token for webhook management (optional)	-
`OPENAI_BASE_URL`	OpenAI API base URL	`https://api.openai.com/v1`
`OPENAI_API_KEY`	OpenAI API key	Required
`OPENAI_MODEL`	Model to use	`gpt-4o-mini`
`PORT`	Server port	`3000`
`WEBHOOK_SECRET`	Webhook signature secret	Required

Custom Prompts

Variable	Description
`CUSTOM_SUMMARY_PROMPT`	Override the default summary review prompt
`CUSTOM_LINE_COMMENT_PROMPT`	Override the default line comment prompt

Admin Dashboard

Variable	Description	Default
`ADMIN_PASSWORD`	Dashboard login password	`password`
`JWT_SECRET`	JWT signing secret	Auto-generated

Feishu Integration

Variable	Description
`FEISHU_WEBHOOK_URL`	Feishu bot webhook URL
`FEISHU_WEBHOOK_SECRET`	Feishu webhook secret (optional)

Agent Review Engine

Enable with REVIEW_ENGINE=agent for advanced multi-agent reviews:

Variable	Description	Default
`REVIEW_ENGINE`	Engine mode (`legacy` or `agent`)	`legacy`
`REVIEW_WORKDIR`	Working directory for repo clones	`/tmp/gitea-assistant`
`REVIEW_MODEL_PLANNER`	Planner model	`gpt-4o-mini`
`REVIEW_MODEL_SPECIALIST`	Specialist model	`gpt-4o-mini`
`REVIEW_MODEL_JUDGE`	Judge model	`gpt-4o-mini`
`REVIEW_MAX_PARALLEL_RUNS`	Max concurrent tasks	`2`
`REVIEW_MAX_FILES_PER_RUN`	Max files per review	`200`
`REVIEW_AUTO_PUBLISH_MIN_CONFIDENCE`	Min confidence for auto-publish	`0.8`
`REVIEW_ENABLE_HUMAN_GATE`	Enable human approval	`true`

Memory & Learning (Experimental)

Variable	Description	Default
`QDRANT_URL`	Qdrant vector database URL	-
`ENABLE_MEMORY`	Enable memory system	`false`
`ENABLE_REFLECTION`	Enable self-critique	`false`
`ENABLE_DEBATE`	Enable multi-agent debate	`false`

Deployment

Docker

docker build -t gitea-assistant .
docker run -d -p 3000:3000 --env-file .env gitea-assistant

Docker Compose

docker-compose up -d

License

MIT License

5.7 KiB Raw Blame History