5.6 KiB
Agent Instructions
桌面端项目计划书已完成并移除;当前桌面端执行约束以本文件为准。桌面端任务包括但不限于 Tauri、macOS、Windows、桌面打包、桌面存储、文件集成、系统通知、自动更新和桌面端安全边界。历史设计只作追溯参考,见 docs/desktop-phase-1-design.md、docs/desktop-phase-2-design.md、docs/audits/desktop-release-stabilization-checklist.md。
桌面端当前不是空白初始化项目。Tauri 基线、macOS 在线桌面壳和第二阶段原生能力主体已经形成;后续工作限于修复、稳定化、体验收口、发布准备、在线辅助缓存和 Windows 兼容验证。不得重新按第一阶段空白项目初始化 Tauri,不得绕过现有 frontend/src/runtime/ 适配层直接在业务模块中使用 Tauri API。
除非用户明确要求先调整本文件中的约束,否则不要实现离线功能、本地业务权威数据存储、内嵌后端服务、离线同步、本地优先工作流或新的阶段性桌面产品线。在线辅助本地缓存只允许作为已认证在线客户端的体验加速能力;处理桌面本地缓存、请求去重、条件请求、缓存诊断或缓存清理相关任务时,必须阅读并遵守 docs/desktop-local-cache-plan.md。
处理前端或桌面端实现时,优先保持以下边界:
- 共享业务代码通过
frontend/src/runtime/index.ts获取平台能力。 - Tauri API 仅允许出现在
frontend/src/runtime/、frontend/src-tauri/或有明确记录的窄入口中。 - 本地缓存能力只能通过
frontend/src/runtime/desktopDataCache.ts、frontend/src/runtime/index.ts、clientRuntime.dataCache和 API 客户端的受控入口暴露;业务模块不得直接使用 Tauri 存储 API、文件系统、SQLite、IndexedDB 或 Cache Storage 实现缓存。 - 未完成后端 token 校验和
/me身份确认前,不得展示业务缓存;登出、切换服务器、切换用户、401/403、权限上下文变化或缓存 schema 变化时必须清理或失效相关缓存。 - 新增或调整 Tauri command、capability、CSP、updater、凭据、文件、通知、本地缓存持久化或底层存储能力时,必须同步评估
frontend/scripts/verify-desktop-release.mjs、npm run runtime:check和桌面发布检查清单是否需要更新。 - token、附件下载凭据和敏感业务信息不得写入 URL、日志、系统通知正文或明文浏览器存储。
- Windows 仍只作为第二阶段兼容性验证目标;未获明确批准前不发布正式 Windows 安装包。Windows 内测构建只能使用
.github/workflows/desktop-windows-internal.yml的手动验证入口,不得生成生产latest.json、updater feed 或正式发布制品。
分支与发布治理
处理代码提交、分支同步、版本晋级、正式发布或生产热修复前,必须先阅读:
docs/guides/branch-maintenance-sop-zh.mddocs/branch-governance.md- 涉及网页端或桌面端客户端发布时,还需阅读
docs/guides/client-release.md
必须遵守以下规则:
- CTMS 网页端和桌面端属于同一个产品,共用
dev、main、release分支,不创建web-dev、desktop-dev、web-release、desktop-release等长期平行分支。 - 默认晋级路径为短期任务分支进入
dev,再由dev晋级到main,最后由main发布到release。 - Agent 创建分支时默认使用
codex/<任务名称>;分支必须从最新dev创建,并在合并到dev后删除。 codex/ctms-desktop是历史桌面端临时集成分支,不再作为当前工作线;不得继续向该分支提交、变基或推送新的桌面端工作,除非用户明确要求做收尾或删除分支。- 生产热修复从
release创建,合并到release后必须依次回合并到main和dev。 - 网页端和桌面端必须使用同一个语义化版本号、正式标签和源代码提交。修改客户端版本时使用
frontend/package.json中的version:set和version:check命令。 - 平台差异必须收敛在
frontend/src/runtime/之后,不能通过长期分支或复制业务代码维护桌面差异。 - 未经用户明确要求,不执行提交、推送、合并、变基、打标签、删除分支或强制更新远程分支。
- 执行用户明确要求的 Git 操作前,先检查工作区和目标分支,只暂存本次任务相关文件,不覆盖或撤销用户已有改动。
- 如果工作区处于 detached HEAD 或包含尚未归属到分支的提交,执行任何分支切换、提交、推送或变基前必须先说明目标基线,并等待用户明确指令。
- 分支治理规则发生变化时,必须同步更新上述治理文档,不能只修改
AGENTS.md。
常用质量门禁
前端或桌面端代码变更应按影响范围执行相关检查。发布、桌面端适配层、Tauri 配置或安全边界相关变更至少考虑:
cd frontend
npm run version:check
npm run release:env:check
npm run runtime:check
npm run desktop:release:check
npm run ui:contract
npm run type-check
npm run test:unit
npm run build
npm run desktop:build:app
本地缓存相关变更至少执行 runtime:check、desktop:release:check、ui:contract、type-check、test:unit 和 build;若新增 Tauri command、capability、CSP 或底层持久化存储,还需执行 desktop:build:app 并在真实桌面 App 中验证缓存清理和诊断入口。
正式桌面发布构建仍必须使用组织批准的 updater 签名私钥和 Apple 签名/公证流程;未签名或 ad-hoc 构建只能作为内部验证构建描述。