Files
ClassHelper/docs/dev/release.md
T
LoveChengke 817af02357 feat(permissions,clients,ai,system,server,web,client,shared)!: 权限组 + 客户端设备远控与自动更新 + 大模型助手 + 系统诊断(1.3.0)
功能级准入改为「权限键」,`requireRole` 退成默认模板。

权限组
- 权限目录(39 键:键 / 中文名 / 分类 / 默认角色)收口到 shared,路由挂 requirePermission / requireAnyPermission
- 有效权限每请求实时算,改完分组立刻生效:ADMIN 全集且 permission:manage、system:manage 不可剥夺;
  CLASS_DEVICE 空集(不受分组影响);有分组 = 并集(因此也能用来**收回**权限);无分组 = 角色默认模板
- 新增「权限组」页:组增删改、成员分配、生效权限预览
- 班级维度的科目规则(assertCanManageSubjectContent)故意不可被权限组覆盖

客户端设备(ClassHelper 桌面端)
- 设备身份是 deviceKey(首次启动生成的 UUID,saveConfig 拒绝改写、退出登录也保留)
- 心跳走「DB 记状态 + 客户端定时拉」,不引入新的长连接:30 秒一次,在线窗口 90 秒
- 远控命令 shutdown / restart / logoff / lock:服务端有效期 10 分钟,客户端弹默认选中「取消」的对话框、
  60 秒未确认按取消处理,执行后必须回执(重复回执幂等),同一台机器同一条命令只弹一次
- 新增「客户端设备」页:版本一览、一键推送更新、下发远控

客户端安装包由服务端下载并缓存(教室机常常没有外网,浏览器也受 CSP 限制)
- POST /api/update/client/fetch 由服务端下载到 data/client-releases/<版本>/ 并登记 sha256 + size
- 自动安装三条护栏:没有 sha256 就拒收、必须等到非上课且主窗口隐藏满 5 分钟、冒烟模式永不安装

大模型助手:只解析、不落库
- POST /api/ai/interpret 返回**待确认**的结构化动作(建作业 / 发通知 / 叫人),
  真正落库仍调既有端点 —— 权限断言、上课时段紧急通知保护、ClassIsland 推送全部自动复用
- 模型给的 params 用与手动入口**同一份** zod 再校验(模型输出不可信)
- API Key 走 AES-256-GCM(密钥由 JWT_SECRET 经 scrypt 派生)加密存 AppSetting,只进不出
- provider=mock 是离线确定性解析,自动化验收一律用它;每次解析写一条 AiAudit(不含密钥)

系统与运维
- 开发者模式(服务端内存缓存开关,热路径不查库;开启后 500 才附 error.stack)、运行诊断(绝不回传密钥)
- 开机自启动运行期可改:Windows 改 HKCU\...\Run、Linux systemctl enable/disable,
  **非安装形态一律返回 supported:false**,不往开发机的注册表里写自启项
- 服务端侧栏折叠只用 CSS 收拢(不重建 DOM),关怀模式只放大字号与控件、不动任何几何令牌

客户端
- 崩溃自愈:渲染进程挂掉 / 超 10 秒无响应先静默重建主窗口(10 分钟最多 3 次),
  未捕获异常只在「没在上课、没人看着」时才重启进程;冒烟模式绝不重启(会杀掉验证实例)
- 上线补弹离线期间收到的消息只做一次:起点只在「可达 → 不可达」的边界写,恢复时取最近 5 条按时间升序推

发布内容批量
- POST /notifications/bulk、POST /homeworks/bulk:**单班失败不影响整批**,逐班返回结果
- 作业的科目名跨班**按名匹配**已有课程,找不到就整班记失败,绝不自动建课
  (自动建课会把创建者写成任课老师,等于越权改任教关系)
- 通知与作业同口径按「所属日期」归档,新增 /notifications/days 与 /notifications/creators

BREAKING CHANGE: 能不能做某件事不再看角色名,而是看权限键(GET /api/permissions/me)。
未分组的账号按角色默认模板生效,行为与 1.2.0 一致;分组之后生效集合只由组的并集决定。
服务端首次启动会自动应用 1 个数据库迁移(权限组 3 表 / AppSetting / 客户端设备·命令·安装包 /
AiAudit / Notification.assignDate / User.careMode,历史通知按本地日期回填),升级前请先备份。
2026-10-11 11:49:32 +08:00

11 KiB
Raw Blame History

title, description
title description
版本迭代与发布 改版本号、跑验收、打安装包、发 GitHub Release、发布文档站——一次完整发布的命令清单。

版本迭代与发布

一条总原则

版本号按「发布」迭代,不按「提交」迭代。

日常的 feat / fix 提交不动版本号。只有当你要产出一批安装包、在 GitHub 上开一个 Release 时, 才走一次完整的版本迭代。理由很实际:安装包、.cipx、Docker 镜像 tag、文档站的版本徽标、 更新检查接口全都按版本号对齐;每次提交都动它,等于每天都在发版,用户那边的「检查更新」就废了。

算一次发布 不算
攒够一批功能 / 修好一个用户能感知的 bug 改注释、改文档、重构、加测试
要给别人一份新安装包 只在自己机器上跑
插件单独发补丁(只动插件第 4 段版本号) —

版本号写在哪(14 处 / 12 个文件)

同一个版本号分散在 14 个落点上,手工改必然漏一处,而漏掉的那处不会报错:

文件 内容
package.json 单一来源(服务端运行时读它)
packages/{shared,server,web-admin,desktop-client}/package.json 各包的版本
deploy/package.runtime.json 安装包 / 容器里的运行时依赖清单
deploy/docker-compose.yml、docker-compose.sqlite.yml 镜像 tag 的默认值
packages/classisland-plugin/manifest.yml 插件清单(四段:x.y.z.0)
packages/classisland-plugin/src/Services/BridgeService.cs 插件上报的 PluginVersion 常量
website/index.html × 3 官网顶栏徽标 / 首屏芯片 / 页脚
website/download.html(<meta name="ch-version">) 下载页读不到版本清单时的兜底版本号

最后两行值得单独说:官网是纯静态站、没有构建步骤,没有哪段代码会去读 package.json, 所以那几处只能靠脚本一起改 —— 漏了的话首页会一直挂着旧版本号(而那是别人看到的第一眼), 下载页则会给离线访客一串指向不存在版本的直链。

所以改版本号的唯一入口是脚本:

pnpm version:check              # 逐处列出并比对,不一致 exit 1
pnpm version:bump patch         # 1.1.2 → 1.1.3
pnpm version:bump minor         # 1.1.2 → 1.2.0
pnpm version:bump major         # 1.1.2 → 2.0.0
pnpm version:check              # 再确认一次

脚本按表逐个改写,任何一处没匹配到或匹配到多处就直接失败退出,不做"尽力而为"的部分改写。

插件版本是 四段 x.y.z.0:前三段跟产品版本走,第 4 段留给"只改插件、不动产品版本"的补丁发布。 --bump / --set 会把第 4 段归零;要单独发插件补丁就手工改那两处(清单 + BridgeService.cs)。

一次完整的发布

下面这一串命令就是全部流程,逐条照抄即可。

1. 改版本号

pnpm version:check
pnpm version:bump patch

2. 本地体检

pnpm lint
pnpm typecheck
pnpm check:icons
pnpm docs:check                 # 文档站构建(警告即失败)

3. 跑验收

pnpm dev:server                 # 另开一个终端跑着

pnpm verify:e2e
pnpm verify:classisland
pnpm verify:classisland-plugin

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

哪一项红了先看验收与测试的「失败时先别改代码」—— 里面列了几个已知脆弱的用例,它们红不代表代码坏了。

4. 打安装包

pnpm dist:all                   # = dist:server + dist:win + dist:classisland-plugin

产物落在 releases/<组件>/<版本>/:安装包/(交付物)、构建中间/(可重新生成)。 没有免安装目录 —— 组装/解包出来的那一份是中间物,打包脚本用完就删(见仓库根 AGENTS.md §4 「交付产物归集」)。

打完之后对打包副本再验一次(开发产物通过 ≠ 用户机器上的副本通过):

# 默认指向装好的客户端;推荐直接拿刚打出来的便携版单文件当被测副本
pnpm verify:packaged --exe "releases/client/<版本>/安装包/ClassHelper-<版本>-x64-portable.exe"

Linux 包只能在 Linux 上构建(依赖是平台相关的),所以不在这条命令里 —— 它由 GitHub Actions 出,见第 7 步。

5. 生成跨组件哈希清单

releases/SHA256SUMS-<版本>.txt 是人读的(表头 + 体积 + 说明),由发布流程维护, 本地只写 Windows 与插件那几行:

cd releases/client/<版本>/安装包 && sha256sum *.exe > ../../../SHA256SUMS-<版本>.txt  # 按实际文件名整理

(Linux 那一行由 CI 在第 7 步里合并进去,不要手工写。)

6. 提交并推上去

git add -A
git commit -m "chore(release): 1.1.3"
git push origin master

提交信息用 Conventional Commits + 模块 scope,描述写中文,可多 scope,例如 fix(island): 胶囊"点不动"的根因——窗口必须始终可激活。

7. 开 Release

上传前先把产物改成 ASCII 名 —— 构建产物是中文名,Release 上的名字是给别人看、要贴进脚本的:

V=1.1.3
mkdir -p .cache/release-staging
cp "releases/client/$V/安装包/"*-x64-setup.exe    ".cache/release-staging/ClassHelper-$V-x64-client-setup.exe"
cp "releases/client/$V/安装包/"*-x64-portable.exe ".cache/release-staging/ClassHelper-$V-x64-client-portable.exe"
cp "releases/server/$V/安装包/"*-x64-setup.exe    ".cache/release-staging/ClassHelper-$V-x64-server-setup.exe"
cp "releases/classisland-plugin/$V/安装包/ClassHelper.ClassIslandPlugin.cipx" .cache/release-staging/

gh release create v$V --title "v$V" --generate-notes
gh release upload v$V .cache/release-staging/* "releases/SHA256SUMS-$V.txt" --clobber
构建产物 Release 上的名字
<客户端>-x64-setup.exe ClassHelper-<版本>-x64-client-setup.exe
<客户端>-x64-portable.exe ClassHelper-<版本>-x64-client-portable.exe
<服务端>-x64-setup.exe ClassHelper-<版本>-x64-server-setup.exe

这三个名字是外部契约:README 的「开始使用」表、官网下载页读不到版本清单时拼的兜底直链, 都按它们写;改名要三处一起改。

gh release create 会创建 tag 并推送,这一步会自动触发 release-linux-server.yml 构建 Linux 包(ubuntu runner)。它跑完之后会:

  1. 把 classhelper-server-linux-x64-<版本>.tar.gz 与 .sha256 挂到 Release 上;
  2. 把 Linux 那一行合并进 SHA256SUMS-<版本>.txt(保留 Windows / 插件那几行)。

顺序很重要:Linux workflow 是在最后一步才去合并 SHA256SUMS 的, 所以第 5 步那份清单必须先上传。万一手速反了(workflow 先跑完、你后上传), 重新跑一次 gh workflow run release-linux-server.yml -f tag=v1.1.3 -f attach=true 就能把那一行补回来。

想手动触发(比如只需要重出 Linux 包):

gh workflow run release-linux-server.yml -f tag=v1.1.3 -f attach=true

8. 官网与文档站

不用做任何事。 推送 master 时只要 website/**、docs/**、scripts/build-pages.mjs 或 package.json 变过, pages.yml 就会把两者构建成同一个 GitHub Pages 站点发出去:

https://lovechengke.github.io/ClassHelper/          ← 官网
https://lovechengke.github.io/ClassHelper/docs/     ← 文档站

(一个仓库在 Pages 上只有一个站点,所以是拼在一起发的 —— 官网在根、文档站在 /docs/ 下。)

文档站顶栏的版本徽标取自根 package.json,所以第 1 步改完就跟着变了; 官网首屏那排芯片、顶栏徽标与页脚里的版本号,以及下载页那个兜底版本号, 也都是由 pnpm version:bump 一起改的(它们是那 14 个落点里的四个)。

官网的「立即下载」会跳到 /download.html,那一页的版本清单是当场从 GitHub Releases 读的 (读不到才退回上面那个兜底版本号),所以发完 Release 不用重新部署那一页 —— 但兜底值要跟着发版一起改, 不然离线访客点到的就是旧版本的直链。

9. 检查

  • Release 页面上四个组件都在,SHA256SUMS-<版本>.txt 里 Windows / 插件 / Linux 三种行齐全;
  • 文档站能打开,顶栏版本号是新版;
  • 装一台机器试一遍(或至少跑 pnpm verify:packaged)。

回滚

发布出去之后发现严重问题:

情形 做法
只是文档 / Release 说明写错 直接改 Release 说明或重发文档站(gh workflow run docs.yml)
二进制有问题 删掉 Release 与 tag(gh release delete v1.1.3 --cleanup-tag),修完重新发;不要拿同一个版本号发第二次内容不同的包
用户已经装了 发一个新版本号(pnpm version:bump patch)修复,不要原地改

已经发出去的版本号不要复用:客户端把它记进「忽略此版本」,服务端与 Web 端各有 30 分钟缓存, 同号换内容会让"检查更新"永久失灵。

相关