管理变更日志对于保持你的应用程序的最新状态至关重要 应用更新 清晰和有条理。这个指南解释了如何创建、结构化和自动化更改日志 Capacitor 应用确保开发者和用户都能得到最新的信息。以下是你将要学习的内容：
- 为什么需要更新日志他们简化了调试、改善了沟通和建立了用户信任。
- 如何结构更改日志: 使用类别“添加”，“修复”和“安全性”以提高清晰度。
- 最佳实践: 在提交之前更新更改日志，使用工具如 Capgo自动化工具
- : 使用CI/CD管道和提交标准来简化更改日志管理。OTA更新
- : 使用详细信息如版本号、时间戳和成功率来记录实时更新。快速提示
: 使用工具如: Automate changelog creation using tools like Capgo to save time and ensure consistency. 95% of users update within 24 hours using Over-the-Air (OTA) solutions.
深入了解指南，设置并将更改日志集成到您的工作流程中。
如何自动为 … 版本和更改日志您的项目。
设置您的第一个更改日志
Creating a clear changelog is key to tracking and sharing updates in your Capacitor app. Here’s how to structure it effectively and follow best practices.
更改日志格式选项
遵循 保持更改日志 遵循标准来按版本和类型组织更新。这一方法使用清晰的类别，使更新易于理解：
| 类别 | 描述 | 示例条目 |
|---|---|---|
| 新增 | 新功能 | 添加推送通知支持 |
| 修改 | 现有功能的更新 | 更新身份验证流程 |
| 废弃 | 即将废弃的功能 | 废弃遗留的API端点 |
| 删除 | 已删除的功能 | 删除过时的分析 |
| 修复 | Bug 修复 | 修复 iOS 相机权限 |
| 安全 | 安全更新 | 增强数据加密 |
构建您的 CHANGELOG.md
要设置您的 CHANGELOG.md确保它始终保持一致且易于阅读。将其放在项目根目录中，并包含以下主要元素：
- 标题部分: 添加您的项目名称和简短描述。
- 版本块: 文档更新遵循语义版本号 (MAJOR.MINOR.PATCH).
- 发布日期: 使用 ISO 格式 (YYYY-MM-DD),例如
2025-03-27. - 变更类别: 将更新分组到适当的标题下。
始终以倒序列出版本，以便最新的更新始终位于顶部。
添加更改日志步骤到开发
将更改日志更新纳入您的工作流程以确保准确和最新的文档。以下是一些实用的技巧:
- 预提交更新: 在提交code更改之前更新更改日志。这有助于减少遗漏重要更新的机会。
- 自动集成: 类似工具Capgo GitHub 操作, GitLab CI, 和 Jenkins [1] 简化更新 changelog 的过程。
- 审阅过程: 将审阅 changelog 条目纳入您的 pull 请求过程中。这确保更新准确且获得批准之前合并。
写出清晰的 changelog 条目
changelog 条目应在技术精确性和可读性之间取得平衡，使其对开发者和用户都有用。
写作风格指南
遵循这些原则确保您的 changelog 条目清晰一致。
- 写作 简化中文
- 开始 动词
- 是 具体 关于什么变化
- 更新依赖项版本
- 尽量避免使用技术术语
例如
| 不明确的条目 | 清晰的条目 |
|---|---|
| 修复bug | 修复 iOS 17.4 设备上的摄像头预览冻结问题 |
| 添加内容 | 添加 Android 的生物识别身份验证支持 |
| 更改 API | 更新用户资料端点以支持新字段 |
| 安全修复 | 补丁 SQLite 在搜索功能中发现注入漏洞 |
更改类型和类别
让用户可以快速找到他们关心的内容。以下是常见类别的分解：
- 添加介绍新功能或功能
- 更改更新或修改现有功能
- 弃用标记功能或功能计划删除
- 已移除表示已删除的功能或功能
- 修复解决bug或问题
- 安全涵盖与安全漏洞相关的补丁或更新
在分配类别时考虑用户的影响。例如，如果核心API更新，列出它在“更改”中，并提供必要的迁移细节。如果是重大更新，请链接到源以获取更多上下文。
添加参考链接
让您的更改日志更有帮助，通过将条目链接到相关文档、问题或提交：
1. 问题参考
直接链接到与更改相关的GitHub问题或拉取请求：
- Fix iOS camera permissions dialog ([#234](https://github.com/your-repo/issues/234))2. 文档链接
当引入新功能或重大变更时，请包含指向更新文档的链接：
- Add push notification support (See [Migration Guide](https://docs.example.com/push))3. 提交引用
对于重大更新，请参见特定提交：
- Update authentication flow (commit: `8f4d89b`)“Capgo 是开发者必备的工具，希望提高生产力的人。避免 bugfix 的审查是黄金的。” - Bessie Cooper
自动化工具更新日志
Automating changelog creation simplifies your workflow and ensures consistent documentation of changes throughout your Capacitor project.
顶部 Changelog 工具
在选择一个 changelog 自动化工具时，应重点关注以下几个关键特性：
- 版本检测: 自动检测新版本
- 提交解析: 从提交消息中提取相关细节
- 集成能力:完美融入您的现有CI/CD管道
- 自定义选项根据您的项目的具体需求
Capgo 让日志更新自动化变得更加容易，通过实时更新来实现 [1]. 已经有超过 750 个应用程序在生产环境中运行，23.5 万次更新已被交付 [1],它已经证明了其可靠性。要充分利用这些工具，确保您的提交消息遵循清晰的结构。
提交信息规范
请使用以下格式提交信息:
[可选信息]
[可选信息]
以下是常见的提交类型:
- feat: 为引入新功能
- fix: 为修复bug
- docs: 为文档变更
- style: For formatting updates
- : For reorganizing code without changing its behavior
- : For adding or updating tests
- : For general maintenance tasks
CI/CD Changelog Setup
通过结合自动化工具与标准化的提交信息，您可以将 changelog 生成整合到 CI/CD pipeline 中。这一设置确保了快速准确的更新。正确配置的 pipeline 可以自动生成 changelog、检查消息格式、更新文档以及通知您的团队。
结果自说自话：95% 的活跃用户在 24 小时内通过 Capgo 的自动部署系统接收更新 [1].
OTA 更新 Changelog 管理
处理 OTA 更新的 changelog 需要额外的关注，因为这些更新会立即部署。与用户手动下载的传统应用商店更新不同，OTA 更新直接到达设备。这使得清晰明确的文档对于维持用户信任以及确保透明度至关重要。
在线更新文档
当管理实时更新时，需要记录关键细节，如捆绑包版本、OTA更新版本、部署时间戳、成功率和用户采用率指标。为了使更改日志易于理解，组织更新分为清晰的类别：
| 分类 | 描述 | 示例条目 |
|---|---|---|
| 关键修复 | 紧急修复程序 | “修复用户认证流程中的崩溃” |
| 功能更新 | 新功能或改进 | “添加了仪表板的暗色模式支持” |
| 性能 | 优化和加速 | ”应用程序加载时间减少了40%” |
| 安全性 | 安全性更新 | ”文件传输加密增强” |
Capgo 更新管理
实时OTA更新需要详细的文档来补充您的总体更改日志策略。Capgo简化了此过程，自动跟踪版本、监控更新性能、记录回滚和记录按渠道部署。
一位管理超过5000名用户的开发人员分享了他们的经历：
“我们在生产环境中部署了Capgo OTA更新，用户数量超过5000。我们看到的操作非常 smooth几乎所有用户在@Capgo部署OTA后几分钟内就已更新。”- colenso [1]
OTA更改日志管理最佳实践:
- 立即记录所有变更。
- 通过渠道跟踪更新以支持分阶段发布。
- 快速解决问题的关键是记录回滚记录。
罗德里戈·曼蒂卡强调了这种方法的重要性：
“我们实行敏捷开发，@Capgo 对于持续向用户交付至关重要！” – 罗德里戈·曼蒂卡 [1]
概要
更改日志管理的关键实践
有效管理更改日志可以增强清晰度并赢得用户信任。以下是一些关键实践：
| 实践 | 描述 | 影响 |
|---|---|---|
| 版本跟踪 | __CAPGO_KEEP_0__ (app 和 OTA) 的版本号跟踪。 | __CAPGO_KEEP_0__ 更新的全球成功率达 82% [1] |
| __CAPGO_KEEP_0__ 更新分类 | __CAPGO_KEEP_0__ 更新 根据类型（修复、功能、安全）分类。 | 95% 的活跃用户在 24 小时内更新 [1] |
| __CAPGO_KEEP_0__ 部署记录 | 记录时间戳、成功率和指标 | 支持监控 2350 万次更新 [1] |
| __CAPGO_KEEP_0__ 回滚策略 | 维护 OTA 集成的前几版本日志 | 允许在必要时立即恢复。 |
更好的管理建议
为了有效地实施这些实践，使用正确的工具至关重要。现代Capacitor应用程序从工具如Capgo中受益，后者简化了更改日志管理，具有以下功能：
- 自动版本控制:通过CI/CD管道轻松跟踪和记录更新。
- 实时分析:实时监控更新性能和用户采用率。
- 频道管理:为更平滑的部署启用beta测试和阶段性发布。
选择更改日志管理工具时，优先考虑：
- 无缝集成:与您的现有工作流程兼容。
- 详细文档: 自动跟踪部署数据。
- 用户更新: 对变更进行清晰、直接的沟通。
通过结合这些实践和合适的工具，您可以建立一个可靠的日志系统，支持持续交付，同时保持用户知情。
“We practice agile development and @Capgo is mission-critical in delivering continuously to our users!” [1]
