yinjianm
33a027e809
Publish frontend, backend, and remote-gateway images to GHCR on pushes to main and manual runs. Also update docker-compose to pull the three service images from ghcr.io instead of Docker Hub.
49 lines
2.5 KiB
Markdown
49 lines
2.5 KiB
Markdown
# workspace-root
|
||
|
||
## 职责
|
||
|
||
管理仓库根目录的 npm workspaces、共享依赖、`patch-package` 补丁应用、GitHub Actions 发布流程以及 Docker Compose 部署编排。该模块不是业务运行时服务，但决定了三个子包如何安装、构建、发布和协同运行。
|
||
|
||
## 接口定义（可选）
|
||
|
||
> 模块对外暴露的公共 API 和数据结构
|
||
|
||
### 公共 API
|
||
| 函数/方法 | 参数 | 返回值 | 说明 |
|
||
|----------|------|--------|------|
|
||
| `package.json#workspaces` | `packages/*` | npm workspace 列表 | 声明后端、前端、远程网关三个子包属于同一工作区。 |
|
||
| `package.json#postinstall` | 无 | shell 命令 | 安装依赖后自动执行 `patch-package`。 |
|
||
| `.github/workflows/docker-publish.yml` | GitHub push / workflow_dispatch 事件 | GHCR 镜像 | 在 `main` 推送时发布三个 `linux/amd64` 业务镜像到 GHCR。 |
|
||
| `docker-compose.yml` | 环境变量、卷、端口映射 | 服务编排 | 统一启动 `frontend`、`backend`、`remote-gateway`、`guacd`。 |
|
||
|
||
### 数据结构
|
||
| 字段 | 类型 | 说明 |
|
||
|------|------|------|
|
||
| `packages/*` | 目录集合 | Monorepo 子包入口。 |
|
||
| `patches/` | 目录 | 第三方依赖补丁存放位置。 |
|
||
| `data/` | 运行时卷目录 | Docker 部署时挂载到后端 `/app/data`。 |
|
||
|
||
## 行为规范
|
||
|
||
### 依赖安装
|
||
**条件**: 在仓库根目录执行 `npm install`。
|
||
**行为**: npm 解析 `workspaces`，统一安装根依赖与子包依赖，并在安装结束后运行 `patch-package`。
|
||
**结果**: 三个子包共享锁文件与依赖树，补丁在安装阶段自动落地。
|
||
|
||
### 容器化部署
|
||
**条件**: 使用根目录 `docker-compose.yml` 启动服务。
|
||
**行为**: `frontend` 暴露 `18111:80`，`backend` 读取根 `.env` 并挂载 `./data:/app/data`，`remote-gateway` 依赖 `guacd` 和 `backend`，三个业务镜像默认从 `ghcr.io/micah123321` 拉取。
|
||
**结果**: Web 入口、REST API、远程桌面网关与 `guacd` 形成完整运行拓扑。
|
||
|
||
### 镜像自动发布
|
||
**条件**: 向 `main` 分支推送代码，或在 GitHub Actions 手动触发 workflow。
|
||
**行为**: `.github/workflows/docker-publish.yml` 使用各子包现有 Dockerfile 构建 `linux/amd64` 镜像，并向 GHCR 发布 `latest` 与 `sha-<commit>` 标签。
|
||
**结果**: 仓库镜像发布链路与 compose 使用的镜像来源保持一致。
|
||
|
||
## 依赖关系
|
||
|
||
```yaml
|
||
依赖: frontend, backend, remote-gateway, docker-compose, .env
|
||
被依赖: frontend, backend, remote-gateway
|
||
```
|