diff --git a/README.md b/README.md index cdf44a6..193d755 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,53 @@ chongming-zenoh/ --- +## 多仓库结构与开发工作流 + +本仓库(**chongming-core**)只跟踪网关核心代码,其余资产分布在独立仓库中: + +| 目录 / 包 | 独立仓库 | 说明 | +| ---------------- | ----------------------------------------------- | -------------------------- | +| `src/chongming/` | 本仓库(chongming-core) | 网关核心(FastAPI + Zenoh)| +| `utils//` | `chongming-utils-*`(9 个,见「工具包列表」) | 工具包,由 `uv sync` 按 git 源安装 | +| `src/plugins/` | `chongming-plugins` | Worker 插件源码 | +| `config/` | `chongming-config` | 应用与 Worker 路由配置 | +| `src/chongming-web/` | `chongming-web` | Vue 3 前端 | + +### 首次克隆(开发环境引导) + +```bash +git clone http://124.71.68.6:3000/chongming/chongming-core.git chongming-zenoh +cd chongming-zenoh +git clone http://124.71.68.6:3000/chongming/chongming-plugins.git src/plugins +git clone http://124.71.68.6:3000/chongming/chongming-config.git config +git clone http://124.71.68.6:3000/chongming/chongming-web.git src/chongming-web +uv sync # utils/* 由 uv 按 pyproject 的 git 源自动安装,无需手工 clone +``` + +### 开发与发布检查清单 + +**修改 `utils/`(工具包)**: + +1. 在 `utils/` 内提交并 push 到对应远程 +2. 回主仓库执行 `uv lock --upgrade-package <包名>` 刷新版本 pin +3. `uv sync` 后运行相关测试 +4. 主仓库提交 `uv.lock` + +**修改 `src/plugins/` / `config/` / `src/chongming-web/`**: + +1. 在对应子仓库内提交并 push +2. 回主仓库启动验证(`uv run serve` + 相关测试) + +**发布前总检查**: + +- [ ] 所有子仓库 `git status` 干净且已 push +- [ ] `uv.lock` 与各 git 源最新提交一致 +- [ ] 配置中无硬编码凭据——密钥一律走环境变量: + `VOLC_ACCESSKEY`(豆包 Ark Key)、`AIBOX_MQTT_URI`(AI Box 外部 Broker URI) +- [ ] `uv run python test_mqtt_e2e.py` 等测试通过 + +--- + ## 快速开始 ### 环境要求 @@ -91,6 +138,8 @@ chongming-zenoh/ ### 安装与启动 +> 首次克隆:先按「多仓库结构与开发工作流」拉取 `src/plugins` / `config` / `src/chongming-web` 子仓库,再执行以下步骤。 + ```bash # 同步依赖(自动编译 Rust 扩展 + 安装 Python 包) uv sync