新用户教程 02
发布归档:让固件、App 和安装包可以追溯
发布归档用于保存交付给测试、生产、客户或现场人员的文件。每次发布都应该能看出版本、来源、变更内容和适用范围。
1. 什么内容适合放 Release
Release 适合保存和某个代码版本强相关的产物。例如单片机固件、App 安装包、上位机工具、烧录工具包、系统安装包和对应说明文档。
- 测试版:用于内部验证,说明风险和已知问题。
- 正式版:用于生产或交付,必须写清适用硬件和版本。
- 回退版:用于现场回滚,必须保留原始文件和校验值。
2. 推荐命名方式
命名要让新人不用打开文件也能判断用途。固件和安装包建议包含项目名、硬件版本、软件版本、日期和环境。
项目名_硬件版本_软件版本_日期_环境.bin MiaooAim_HW-A_V1.2.0_20260823_test.bin MiaooAim_Tool_V1.2.0_20260823_windows.zip
3. 发布说明要写什么
发布说明不是聊天记录,应该让以后排查问题的人快速理解这一版为什么发布。
- 新增:本次增加了哪些能力。
- 修复:解决了哪些问题,最好关联 Issue。
- 风险:还有哪些已知限制。
- 验证:谁验证过,在哪个硬件版本上验证。
4. 校验值和下载
较大的包或给现场使用的固件建议附带 SHA256,避免传输或复制过程中损坏。
sha256sum MiaooAim_HW-A_V1.2.0_20260823_test.bin
发布之后不要随意替换同名附件。发现文件错误时,新建一个修正版本,并在说明里写清原因。