LMES补丁打包规范说明
📋 概述
本文档详细说明了LMES补丁打包工具的使用规范和版本管理规则,确保补丁打包过程的标准化和可追溯性。

🔢 版本号规范
📌 版本格式
LMES补丁版本采用四段式版本号格式:
主版本.次版本.修订版本.补丁版本
示例:
2.7.1.6
📊 版本号含义
| 段落 | 含义 | 示例 |
|---|---|---|
| 2.7.1 (前三段) | 产品版本号,对应主程序的版本 | 2.7.1 |
| 6 (第四段) | 补丁版本号,每次发布补丁时必须递增 | 6 |
⚠️ 版本号管理规则
- 产品版本号(前三段)必须与主程序版本保持一致
- 补丁版本号(第四段)从1开始,每次发布新补丁必须
+1 - 不允许跳号,必须按顺序递增
🔄 打包流程
1️⃣ 准备工作
在开始打包前,请确保以下准备工作已完成:
✅ 目录结构检查
- 确保LMES-Patch目录结构完整
- 检查hotplugsprofile.json配置文件存在
- 确认CMS.HotPlug.Packer.exe打包工具可用
✅ 必需文件验证
- 必须确保LMES-Patch根目录下存在**
LMES补丁说明.txt**文件
2️⃣ 版本输入
运行打包脚本时,需要输入完整的四段式版本号。
格式要求:
2.7.1.6
输入提示说明:
- 🔴 红色提示:显示版本号格式示例
- 🟡 黄色说明:明确告知版本号各部分的含义
3️⃣ 自动配置
脚本会自动执行以下配置:
⚙️ 配置文件更新
- 更新
hotplugsprofile.json中的版本信息 - 设置补丁描述信息(包含打包时间戳)
- 配置依赖关系信息
4️⃣ 打包输出
📦 生成补丁包
- 生成
.cmsplugs格式的补丁包文件 - 文件名格式:
lmes-v{产品版本}-patch{补丁版本}.cmsplugs - 示例:
lmes-v2.7.1-patch6.cmsplugs
5️⃣ 更新机制
🔁 LMES补丁采用累积性更新模式
| 机制 | 说明 |
|---|---|
| 📁 新补丁包含旧补丁所有文件 | 每次打包都是完整的文件集合 |
| 🔄 同名文件覆盖机制 | 新补丁中的同名文件覆盖旧补丁的同名文件,表示该文件在新版本中有更新 |
| ⚡ 直接覆盖安装 | 安装时无需卸载旧版本,新文件直接覆盖旧文件 |
| 📈 累积性更新 | 安装最新补丁即可获得所有历史功能 |
📄 配置文件说明
🔧 hotplugsprofile.json
⚠️ 重要提醒:由打包脚本自动更新,无需手动修改
包含补丁包的基本信息和元数据:
{
"HotPlugs": [
{
"HotPlugId": "LMES-Patch",
"HotPlugName": "LMES-Patch",
"Category": "LMES",
"Version": "v2.7.1.6",
"Description": "LMES补丁 (2024-12-19 14:30:45)",
"Dependencies": [
{
"HotPlugId": "LMES",
"Version": "v2.7.1"
}
]
}
]
}
📋 字段说明
| 字段名 | 说明 | 生成方式 |
|---|---|---|
| HotPlugId | 补丁标识符,固定为"LMES-Patch" | 自动生成 |
| HotPlugName | 补丁名称,固定为"LMES-Patch" | 自动生成 |
| Category | 分类,固定为"LMES" | 自动生成 |
| Version | 完整版本号,包含v前缀 | 自动更新 |
| Description | 补丁描述,自动附加打包时间戳 | 自动更新 |
| Dependencies | 依赖关系,指定对主程序的版本依赖 | 自动配置 |
⏰ 时间戳规范
📅 格式要求
所有补丁包描述信息中自动包含打包时间戳,格式为:
yyyy-MM-dd HH:mm:ss
🎯 示例
LMES补丁 (2024-12-19 14:30:45)
✅ 作用
- 🕐 精确记录补丁生成时间
- 📊 便于版本追溯和管理
- 🔄 支持同一天内多次打包的区分
🔗 依赖关系管理
⚙️ 依赖配置
每个补丁包都会自动配置对主程序的版本依赖:
| 字段 | 值 | 说明 |
|---|---|---|
| HotPlugId | "LMES" | 主程序标识 |
| Version | "v2.7.1" | 产品版本号(前三段) |
🔍 依赖检查
确保补丁版本与主程序版本匹配,避免版本不兼容问题
📤 输出文件规范
🏷️ 文件命名
生成的补丁包文件遵循统一命名规范:
lmes-v{产品版本}-patch{补丁版本}.cmsplugs
📋 文件示例
lmes-v2.7.1-patch1.cmsplugslmes-v2.7.1-patch2.cmsplugslmes-v2.7.1-patch8.cmsplugs
📍 文件位置
补丁包生成在当前目录下,与打包脚本同级
❌ 错误处理
🔢 版本号格式验证
- ✅ 必须输入四段式版本号
- ✅ 每段必须是有效的数字
- ❌ 格式不正确时会显示红色错误提示并退出
⌨️ 输入验证
- ⚠️ 未输入版本号时会显示红色警告
- 🔄 提供重新输入的机会
- 🚪 连续未输入将自动退出脚本
💡 最佳实践
📝 版本发布建议
- 📈 每次发布补丁前确认补丁版本号正确递增
- 🎯 保持产品版本号与主程序版本一致
- 📝 记录每次补丁的变更内容和发布时间
- 💾 保留历史补丁包用于版本回滚
✅ 打包前检查清单
- 确认版本号格式正确
- 验证补丁版本号已递增
- 检查LMES-Patch目录结构完整
- 📄 检查LMES-Patch根目录下存在**
LMES补丁说明.txt**文件 - 确认所有修改文件已就绪
- 验证新补丁包含所有历史文件(全量更新)
- 确认同名文件覆盖是预期更新(新文件正确替换旧文件)
- 预留足够的打包时间