4.5 KiB
4.5 KiB
Issue#4 验收单:版本号 + 发布日志(2026-11-16)
工单:Gitea Tory/go-sms-V2#4「增加:版本号及发布日志」。纯前端交付(后端零改动);门禁四件 + verify-layout 全绿。
一、需求与落点
| 需求原文 | 落点 | 状态 |
|---|---|---|
| ①菜单底部,折叠展开旁边增加最新版本号,有更新时增加红点闪烁提示 | MainLayout.vue sidebar-foot 折叠按钮旁版本 chip(data-testid=sidebar-version,点击进发布日志页);红点=未读时 gosms-ver-blink CSS 脉冲闪烁 |
✅ |
| ②系统管理增加二级菜单「发布日志」,功能迭代明细,运营大白话,Markdown 格式 | 路由 /system/release(全角色,同 faq 口径,用户拍板);ReleaseLog.vue 时间线卡片;utils/markdown.ts 迷你渲染器 |
✅ |
二、交付清单
| 文件 | 说明 |
|---|---|
web/src/data/releases.ts |
单一事实源:版本列表(最新在前,6 个版本 v1.0.0~v1.5.0,运营大白话 Markdown);APP_VERSION = RELEASE_NOTES[0].version;文件头含发版 SOP |
web/src/utils/markdown.ts |
迷你 Markdown→HTML(零新依赖):标题/无序有序列表(1. 与 1、 均支持)/粗体/行内代码(哨兵保护)/围栏代码块/链接(仅 http(s));先全量 HTML 转义再解析 |
web/src/stores/release.ts |
pinia store:hasUpdate(localStorage gosms_seen_ver ≠ APP_VERSION)/markSeen() |
web/src/views/system/ReleaseLog.vue |
发布日志页(defineOptions name='system-release'):hero 当前版本 + 版本时间线卡片(版本徽章/日期/标签/当前版本角标)+ Markdown 渲染 |
web/src/layouts/MainLayout.vue + styles/shell.scss |
sidebar-foot 版本 chip(红点闪烁动画/折叠态 64px 短版本纵向/暗亮主题 token) |
web/src/router/routes.ts |
system/release 路由(系统管理组,全角色,icon=Memo) |
web/package.json |
version 0.1.0 → 1.5.0(与 APP_VERSION 同步,测试断言防漂移) |
web/tests/releases.spec.ts |
+14 用例(数据一致性 4/渲染器 7/store 3) |
web/tests/guard.spec.ts role-menu-matrix.spec.ts web/scripts/verify-layout.mjs |
菜单计数 33→34 显式更;矩阵登记 system-release: ALL;布局断言 23→31 |
三、设计口径
- 单一事实源:版本号只在
releases.ts头条维护;APP_VERSION自动取首条,package.json同步(测试两侧一致断言)。发版 SOP:releases.ts 头部插一条(minor=功能/patch=修复)+ package.json version 同步,部署后全员红点自动亮起。 - 红点语义(本地未读):localStorage
gosms_seen_ver存"上次已看过的版本";≠ 当前版本即亮;首访无记录=亮(引导看一次);点击 chip / 进入发布日志页即markSeen()熄灭;发新版后全员再亮。 - Markdown 安全:内容源=仓库静态数据(非用户输入),渲染器仍按不可信文本处理——先全量 HTML 转义再解析,链接仅 http(s)(javascript: 伪协议不渲染为
<a>),v-html 零注入面。 - 折叠态适配:64px 窄栏下 chip 缩为无边框短版本(v1.5.0 → v1.5),与折叠按钮纵向排布;hover title 提示完整版本与更新引导。
四、门禁
- eslint 0 警 / vue-tsc 0 / vitest 179 全绿(165+14)/ build ✓(chunk 剖面不变)。
- verify-layout 31/31(Chrome 实机,:5173,s2demo 登录):新增 8 项=chip 可见、文本
vN.N、首访红点存在、点击进发布日志、已读红点即灭、版本卡片 ≥3、Markdown 列表渲染、回 home。 - 浏览器实机走查截图:
/tmp/issue4-*.png(红点态/已读态/折叠态/发布日志页)。
五、口径与边界(诚实标注)
- 红点为浏览器本地"未读"语义:换浏览器/清缓存会重新提示一次;无服务端已读同步(单机管理后台语义够用,如需全员强提醒再挂后端)。
- 移动端(≤900px):sidebar-foot 沿用既有
display:none约定,版本号仅桌面侧栏可见(工单语境为桌面管理后台)。 - 发布内容为仓库静态数据:运营改文案=编辑
releases.ts(TypeScript 文件,格式有测试守门);不提供后台在线编辑(无需求,且内容发布本就应走代码评审)。 - CHANGELOG.md(技术向,仓库根)与发布日志(运营向,前端)是两份受众不同的内容,发版时各自更新。
六、遗留与下一步
- Gitea 工单 #4 完成评论待用户贴(写评论需 token)。
- 版本线 v1.0.0~v1.4.0 的日期/内容为按 CHANGELOG 重建的运营向回顾(口径:一期 11-13 上线为 v1.0.0),如与用户预期划分不同,改
releases.ts即可(纯数据)。