复现已有算法
This commit is contained in:
@@ -0,0 +1,90 @@
|
||||
---
|
||||
name: edge-release-notes
|
||||
description: edge_collector 版本说明与变更日志编写规范。用于提交、push、边缘包发布、云平台部署、OTA 发布、阶段交付时,生成面向用户、运维和开发的 release notes,区分用户可见变化、部署影响、配置影响、验证结果和回滚说明。
|
||||
---
|
||||
|
||||
# edge_collector 版本说明
|
||||
|
||||
## 适用场景
|
||||
|
||||
- 提交前整理变更。
|
||||
- push 后总结。
|
||||
- 边缘版本发布。
|
||||
- 云平台部署。
|
||||
- OTA 包说明。
|
||||
- 阶段交付说明。
|
||||
|
||||
## 读者分层
|
||||
|
||||
- 用户可见:功能变化、操作入口、体验优化。
|
||||
- 运维可见:部署步骤、配置变化、服务重启、回滚。
|
||||
- 开发可见:代码结构、接口、测试、技术债。
|
||||
|
||||
不要把内部 helper、SDK 路径、密钥、模型配置写进用户可见说明。
|
||||
|
||||
## 推荐结构
|
||||
|
||||
```markdown
|
||||
## 版本信息
|
||||
|
||||
- 版本:
|
||||
- 日期:
|
||||
- 范围:
|
||||
|
||||
## 用户可见变化
|
||||
|
||||
## 运维与部署影响
|
||||
|
||||
## 配置变化
|
||||
|
||||
## 修复问题
|
||||
|
||||
## 验证结果
|
||||
|
||||
## 已知风险
|
||||
|
||||
## 回滚说明
|
||||
```
|
||||
|
||||
## 从 Git 生成摘要
|
||||
|
||||
可参考:
|
||||
|
||||
```bash
|
||||
git log --oneline -10
|
||||
git diff --stat HEAD~1..HEAD
|
||||
git status --short
|
||||
```
|
||||
|
||||
只总结和本次发布相关内容,不把无关工作区改动写进版本说明。
|
||||
|
||||
## 边缘发布说明
|
||||
|
||||
必须说明:
|
||||
|
||||
- 目标架构。
|
||||
- 是否需要执行 `install_all.sh`。
|
||||
- 是否需要重启 `edge` 或独立 agent。
|
||||
- 是否影响运行态动态配置。
|
||||
- 是否通过目标主机验证。
|
||||
|
||||
## 云平台发布说明
|
||||
|
||||
必须说明:
|
||||
|
||||
- 是否执行 `deploy_cloud.sh`。
|
||||
- 是否使用 `--init`。
|
||||
- 是否影响 `ai_config.json`、`server_config.json`。
|
||||
- 是否重启 `cloud-server`、Mosquitto、nginx。
|
||||
- 公网接口验证结果。
|
||||
|
||||
## OTA 包说明
|
||||
|
||||
面向用户时写:
|
||||
|
||||
- 新增能力。
|
||||
- 修复问题。
|
||||
- 升级注意事项。
|
||||
- 回滚建议。
|
||||
|
||||
避免写内部提交号、代码路径和密钥。
|
||||
Reference in New Issue
Block a user