1 Fork 0

Files

T

LoveChengke 19c2aa07b2 feat(docs,scripts,build): 用 docfx 搭文档站并发布到 GitHub Pages，版本号收口成脚本迭代

文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）：

- 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/
  管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来：
  顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统；
- 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案
  （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标，
  并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）；
- 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入），
  不在文档里写第二份 —— 否则一定漂；
- 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径**
  解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与
  workflow（CI 传 `/<仓库名>/`）分别注入；
- 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里，
  而 Pages 上传的是整个目录。

版本迭代（**每一次 releases，不是每一次提交**）：

- 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、
  `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的
  `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上
  表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1）
  与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处
  就直接失败退出，不做尽力而为的部分改写）；
- `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、
  完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` →
  Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。

其它：

- `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并
  部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何
  `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏；
- docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens`
  移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新；
- 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL，
  否则上线全是 404；
- 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成，
  仍然只有一个图形源 `build/classhelper.{png,ico}`）；
- `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores；
- 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。

2026-10-06 16:27:44 +08:00

7.3 KiB

Raw Blame History

title, description

title	description
验收与测试	五套验收脚本怎么跑、覆盖什么、哪些用例是脆弱的，以及怎么判断失败是不是真回归。

验收与测试

这个仓库的验收方式是跑真东西：真的起后端、真的开 Electron 窗口、真的点击菜单、真的发一条通知。不是单元测试，是端到端回归。

五套脚本

命令	覆盖	需要什么
`pnpm verify:e2e`	后端 + 实时推送 + RBAC 越权 + 上课时段 + 导入 + 班级账号 + 数据库管理 + 更新检查	后端已启动
`pnpm verify:web`	Web 管理端真实点击回归（Electron 驱动）	后端已启动 + Web 产物已构建
`pnpm verify:desktop`	客户端冒烟（Electron，无人工点击）	已构建的客户端产物
`pnpm verify:packaged`	对打包后 / 已安装的客户端 EXE 复跑同一套冒烟（`--exe` 指定路径）	打包产物
`pnpm verify:classisland`	设备令牌 / 上报 / 提醒下发与回执 / 镜像契约 / 幽灵行清理	后端已启动
`pnpm verify:classisland-plugin`	插件静态契约（清单一致性 / 注册完整性 / C# DTO ↔ 服务端 zod 与路由）	不需要 .NET，也不需要后端

条目数由脚本自行统计并打印（=== 结果：N/N 项通过 ===），文档里不写死容易过期的总数 —— 每次跑完看脚本输出。

另外三套是"门禁"而不是验收：pnpm typecheck、pnpm lint、pnpm check:icons。

一次完整的交付前检查

pnpm lint                # ESLint，0 error 是底线
pnpm typecheck           # 全仓库类型检查（含 vue-tsc）

pnpm dev:server          # 另开一个终端
pnpm verify:e2e
pnpm verify:classisland
pnpm verify:classisland-plugin

pnpm build:desktop && pnpm verify:desktop
pnpm build && pnpm verify:web

改动涉及打包/交付形态时，再加 pnpm dist:all 与 pnpm verify:packaged --exe "<客户端路径>"（开发产物通过不等于用户机器上的副本通过）。

失败时先别改代码

下面这些用例不是回归，遇到时先看条件。完整清单在 AGENTS.md 的「已知脆弱用例」表。

用例	触发条件
`verify:desktop`「真实通知链路」「灵动岛标为已读」等 3 项	要求当前不在上课时段。种子课表恰有课正在进行时，客户端会正确地把普通通知暂存到下课 —— 这三项就会红（日志里会写 `客户端判定上课中=true`）
`verify:e2e`「上课状态接口（at=周一 08:10）」	种子把周一第 1 节限制在第 1 周，且用例把 `2026-09-07` 当第 1 周。`.env` 的 `TERM_START_DATE` 对齐即可全绿
`verify:web`「课表科目为全校统一目录」	种子给每个班建满了全部科目，下拉里就没有可自动建课的「统一科目」分组
`verify:desktop`「课表今天时间轴」	凌晨约 00:00–03:00 时「已结束」探针被夹紧成 0 长度而被过滤
`verify:desktop`「作业看板全屏自适应」	演示数据某天有 6 条长作业、而冒烟窗口只有约 543px 高时，缩放被下限 0.45 钳住 → 必然溢出
岛交互 / 岛动画 / 岛截图留档	AI 会话里会间歇性失败：置顶透明小窗的 rAF 被限流、形变采样抓不到帧。先原样重跑一次再动手改

大面积报「登录失败 / 401」时

先核对本机 teacher1 的密码 —— 本机实测可能被改成了 123456，不是种子默认的 teacher123 （原因是「修改密码」弹窗留空会落到默认初始密码）。处理方式是用环境变量传实际凭据，不要去改数据。

两个演示账号的口令不一定一起漂，所以不能简单地全局替换。

脚本	覆盖凭据的方式
`verify:desktop`	`set "ELECTRON_SMOKE_USER=teacher1" && set "ELECTRON_SMOKE_PASSWORD=123456" && pnpm verify:desktop`
`verify:packaged`	同上（`ELECTRON_SMOKE_*`）
`verify:web`	`set "UI_SMOKE_USER=teacher1" && set "UI_SMOKE_PASS=123456" && pnpm verify:web`（另有 `UI_SMOKE_ADMIN*`）
`verify:e2e`	不支持环境变量，需用临时副本替换（且副本必须放在 `packages/server/scripts/` 里，否则 `import 'socket.io-client'` 会失败）

冒烟会真的动你的屏幕

verify:web / verify:desktop / verify:packaged 会真的弹窗口、真的发通知、真的移动鼠标：

跑的时候别动键鼠；
验证实例的灵动岛是洋红主题色（#e91e8c），一眼可以与你自己客户端那个区分开。两条反馈里的"屏幕上出现了第二个灵动岛""点它反应不对"都源于这个叠影；
冒烟会往演示班发几条「张老师 · 自检」通知，用完即删；中途被 kill 会留下残条。

截图留档

回归测试顺手把截图存到 docs/screenshots/（island / client / web-mobile / classisland 四组），文档站里用的就是这些图。要重新采集：

pnpm dev:server
ISLAND_SHOTS_DIR=F:/ClassHelper/.cache/island-shots \
ELECTRON_CLIENT_SHOTS_DIR=F:/ClassHelper/.cache/client-shots \
ELECTRON_SMOKE_ISLAND_ACCENT='#0a84ff' ELECTRON_SMOKE_ISLAND_STYLE=black \
ELECTRON_SMOKE_USER=teacher1 ELECTRON_SMOKE_PASSWORD=123456 \
  node packages/desktop-client/scripts/smoke.mjs

官网的实机图则用 website/tools/capture-shots.mjs（采集步骤见 README.md §7）。

采集脚本会把窗口真的弹在屏幕上。客户端留档会临时停掉 CSS 动画再截图 —— 窗口被遮挡时 Chromium 冻结动画，而页面入场动画的起始帧是 opacity: 0，不停掉的话截出来是整片空白（DOM 里文本齐全，只有图是空的）。

7.3 KiB Raw Blame History Unescape Escape