RailWise KB已发布
TSM版本发布说明
RAILWISE-TSM全站仪自动化监测平台版本发布说明的标准模板,规范服务端、客户端、固件更新的发布格式。
community-guide
TSM版本发布说明模板
Section titled “TSM版本发布说明模板”本文档为RAILWISE-TSM版本发布说明的标准模板。TSM包含服务端、Web客户端、移动端和仪器固件,发布说明需涵盖所有组件的更新内容。
# RAILWISE-TSM v{主版本}.{次版本}.{修订版本} 发布说明
> **发布日期**: {YYYY-MM-DD}> **版本类型**: {major | minor | patch}> **维护等级**: {LTS(长期支持) | STS(短期支持) | EOL(停止维护)}> **下载地址**: [官网下载](https://www.railwise.cn/tsm/download)
---
## 版本概述
{简要描述本版本的核心价值和适用场景}
:::info 版本兼容性- **服务端最低版本**: v{版本号}- **客户端最低版本**: v{版本号}- **固件最低版本**: v{版本号}- **数据库兼容性**: 兼容v{版本号}+:::
---
## 服务端更新
### 新功能
#### {功能名称}
- **功能描述**: {功能用途}- **API变更**: {新增或变更的API}- **配置变更**: {新增或变更的配置项}- **性能影响**: {对服务端性能的影响}
### 改进
- {改进项}: {改进描述}
### 修复
- **{问题编号}**: {问题描述}(影响版本: {版本范围})
### 部署注意事项
- **数据库迁移**: {是否需要执行迁移脚本}- **配置更新**: {是否需要更新配置文件}- **依赖更新**: {是否需要更新系统依赖}- **重启要求**: {是否需要重启服务}
---
## Web客户端更新
### 新功能
#### {功能名称}
- **功能入口**: {界面路径}- **浏览器支持**: {支持的浏览器及版本}- **响应式**: {是否支持移动端浏览器}
### 界面改进
- {改进项}: {改进描述}
**[截图占位符: 界面截图]**
### 修复
- **{问题编号}**: {问题描述}
---
## 移动端更新(iOS/Android)
### 新功能
- {功能名称}: {功能描述}
### 兼容性
| 平台 | 最低版本 | 推荐版本 ||------|---------|---------|| iOS | {版本} | {版本} || Android | {版本} | {版本} |
### 更新方式
- **App Store**: 自动更新或手动更新- **Google Play**: 自动更新或手动更新- **APK下载**: [下载地址]
---
## 固件更新
### 支持的仪器型号
| 仪器型号 | 固件版本 | 更新方式 ||---------|---------|---------|| Leica TM60 | v{版本} | 在线/离线 || Leica TS16 | v{版本} | 在线/离线 || Trimble S9 | v{版本} | 离线 |
### 固件更新内容
- {更新项}: {更新描述}
### 固件更新步骤
1. 登录TSM管理界面2. 进入 `系统管理 > 固件管理`3. 选择需要更新的仪器4. 点击 `更新固件`5. 等待更新完成(约10-30分钟)
:::warning 固件更新警告- 固件更新期间仪器不可使用- 更新前确保仪器电量充足- 更新过程中不要断开电源或通信- 建议在工作间隙执行更新:::
---
## 数据库变更
### 迁移脚本
| 脚本名称 | 适用版本 | 执行时间 | 影响 ||---------|---------|---------|------|| {脚本名} | {版本范围} | {预计时间} | {影响说明} |
### 数据备份建议
升级前强烈建议执行数据备份:
```bash# 使用TSM CLI备份tsm-cli backup create --name "pre-upgrade-{版本号}"
# 或使用Docker备份docker exec tsm-postgres pg_dump -U tsm_user tsm_db > tsm_backup_{日期}.sql安全配置更新
Section titled “安全配置更新”新增安全特性
Section titled “新增安全特性”- {特性名称}: {特性描述}
- CVE-{编号}: {漏洞描述}(严重等级: {等级})
- {安全建议内容}
| 指标 | 上一版本 | 当前版本 | 提升 |
|---|---|---|---|
| 并发测站数 | {数值} | {数值} | {百分比} |
| 数据处理吞吐量 | {数值} | {数值} | {百分比} |
| 查询响应时间(P95) | {数值}ms | {数值}ms | {百分比} |
| 内存占用(100测站) | {数值}GB | {数值}GB | {百分比} |
# 1. 备份数据tsm-cli backup create --name "pre-upgrade"
# 2. 拉取新版本docker-compose pull
# 3. 执行数据库迁移docker-compose exec tsm-server npm run db:migrate
# 4. 重启服务docker-compose up -d
# 5. 验证升级curl http://localhost:8080/api/v1/healthWeb客户端随服务端自动更新,无需手动操作。移动端请前往应用商店更新。
如升级后出现问题,可执行回滚:
# 1. 停止服务docker-compose down
# 2. 恢复数据tsm-cli backup restore --name "pre-upgrade"
# 3. 回退版本docker-compose pull tsm-server:{上一版本}
# 4. 重启服务docker-compose up -d已知问题与限制
Section titled “已知问题与限制”- {问题描述}: {临时解决方案}(预计{版本}修复)
- 紧急问题: 拨打技术支持热线 400-XXX-XXXX
- 一般问题: GitHub Issues
- 功能建议: Discussions
- 安全漏洞: security@railwise.cn(PGP公钥)
版本生命周期
Section titled “版本生命周期”| 版本 | 发布日期 | 维护状态 | 支持截止日期 |
|---|---|---|---|
| v{版本} | {日期} | LTS | {日期} |
| v{版本} | {日期} | STS | {日期} |
| v{版本} | {日期} | EOL | {日期} |
## 版本类型说明
| 类型 | 说明 | 维护周期 | 适用场景 ||------|------|---------|---------|| LTS | 长期支持版本 | 24个月 | 生产环境 || STS | 短期支持版本 | 6个月 | 新功能体验 || EOL | 停止维护 | - | 建议升级 |
## 发布 checklist
- [ ] 所有组件测试通过- [ ] 数据库迁移脚本验证通过- [ ] 固件兼容性测试通过- [ ] 性能基准测试完成- [ ] 安全扫描通过- [ ] 文档更新完成- [ ] 回滚方案验证通过- [ ] 发布说明编写完成
---
## 相关文档
- [CLI更新日志模板](update-cli-changelog-template.md)- [WorkWise更新说明模板](update-workwise-release.md)- [通用更新流程指南](update-general-process.md)
<!-- AI语义标签: 版本发布, TSM, 服务端, 客户端, 固件更新 -->