Dashboard 仓库接入 Runbook
更新时间:2026-03-15
本 runbook 用于把当前仓库的 extensions 契约与模板,接入真实 dashboard 仓库。
1. 前置条件
- 可访问 dashboard 仓库本地路径。
- dashboard 使用 Node.js 18+。
- dashboard 能执行
npm ci。
2. 一键 bootstrap
在本仓库执行:
powershell -File scripts/contracts/bootstrap-dashboard-contracts.ps1 -DashboardRoot <dashboard_repo_path>
执行后 dashboard 仓库将获得:
src/services/contracts/extensions.tssrc/services/generated/extensions-client/**src/services/adapters/extensions.tssrc/services/api/extensions.tssrc/services/errors/codes.tssrc/services/errors/mapper.ts.github/workflows/extensions-regression.yml
3. 页面接线顺序
Extensions/Store页面接createExtensionApi().listCatalog/install。Extensions/Installations页面接listInstallations/enable/disable/upgrade/uninstall。- 安装详情页接
listEvents/health-check/reconcile。 - 所有错误统一走
mapExtensionError。
4. 验证
- 运行前端单测/构建。
- 运行 Playwright:
src/tests/smoke/extensionssrc/tests/visual/extensions
- PR 中启用
extensions-regression工作流。
5. 回滚
如果接入后出现阻断:
- 保留生成的
contracts/generated文件。 - 页面层回退到旧调用,但保留
errors/mapper。 - 分批切回 adapter 层,避免一次性全量替换。
