更新应用程序 更新应用 透明和有条理。这个指南解释了如何创建、结构和自动化更改日志以 Capacitor 应用,以确保开发者和用户都能得到最新的信息。以下是您将要学习的内容:
- 为什么更改日志重要:它们简化了调试、改善了沟通和增强了用户信任。
- 如何结构更改日志:使用类别“添加”、“修复”和“安全”以提高清晰度。
- 最佳实践:在提交前更新更改日志，使用工具 Capgo,并在pull请求期间审查条目。
- 自动化工具使用 CI/CD pipeline 和提交标准来简化更改日志管理。
- OTA 更新: 使用 __CAPGO_KEEP_0__ 等工具来实时记录更新细节，例如版本号、时间戳和成功率。
快速提示: 使用 Capgo 等工具来自动创建更改日志，节省时间并确保一致性。95% 的用户在 24 小时内使用 OTA 解决方案进行更新。
深入了解指南，设置并集成第一个更改日志。
如何自动化项目的版本号和更改日志 …
设置第一个更改日志
创建清晰的更改日志对于跟踪和分享应用程序 Capacitor 的更新至关重要。以下是如何有效地结构它并遵循最佳实践。
更改日志格式选项
遵循 《更新日志管理》 标准化更新日志，按版本和类型组织更新。这种方法使用明确的分类，使更新更容易理解：
| 分类 | 描述 | 示例条目 |
|---|---|---|
| 添加 | 新功能 | 添加推送通知支持 |
| 修改 | 现有功能的更新 | 更新了认证流程 |
| 弃用 | 即将移除的功能 | 废弃的遗留API端点 |
| 已移除 | 已移除的功能 | 已移除过时的分析 |
| 已修复 | 修复 | 修复 iOS 相机权限 |
| 安全 | 安全更新 | 增强数据加密 |
构建您的 CHANGELOG.md
To set up your CHANGELOG.md确保它保持一致且易于阅读。将其放在项目根目录中，并包含以下主要元素：
- Header Section: 添加项目名称和简要描述。
- Version Blocks: 在语义版本号（MAJOR.MINOR.PATCH）下记录更新。
- Release Dates: 使用ISO格式（YYYY-MM-DD），例如
2025-03-27. - Change Categories: 根据适当的标题分组更新。
总是以最新更新为首，倒序排列版本，以便最新的更新始终位于顶部。
Adding Changelog Steps to Development
Incorporating changelog updates into your workflow ensures accurate and up-to-date documentation. Here are some practical tips:
- 提交前更新: 在提交 code 变更之前更新 changelog。 这样可以减少遗漏重要更新的机会。
- 自动化集成: 工具如 Capgo 可以与 GitHub Actions, GitLab CI, 和 Jenkins [1] 一起简化更新 changelog 的过程。
- 审查流程: 将审查 changelog 条目纳入您的 pull request 流程中。 这样可以确保更新准确且已获得批准之前合并。
写出清晰的更改日志条目
更改日志条目应在技术精确性和可读性之间取得平衡，使其对开发者和用户都有用。
写作风格指南
遵循这些原则来确保您的更改日志条目清晰一致:
- 使用 现在时态
- 从 动词
- 要 具体 关于发生了什么变化
- 提到依赖项版本的更新
- 使用最少的技术术语
示例：
| 不明确的条目 | 清晰的条目 |
|---|---|
| 修复了bug | 修复iOS 17.4设备上的摄像头预览冻结问题 |
| 添加了内容 | 添加Android上的生物识别认证支持 |
| 改变了API | 更新用户资料端点以支持新字段 |
| 安全修复 | 补丁 SQLite 在搜索功能中的注入漏洞 |
更改类型和类别
组织您的更新以便用户快速找到他们关心的内容。以下是常见类别的分解:
- 添加: 引入新功能或功能
- 修改: 更新或修改现有功能
- 弃用: 标记计划被移除的功能或功能
- 删除: 表示已被移除的功能或功能
- 修复: 解决了 bug 或问题
- 安全性context: 企业产品/定价页面. 角色: UI 标签. 见于: 企业.astro 页面. 消息键 `enterprise_hero_security_label` (企业英雄安全标签)
Consider the user impact when assigning categories. For instance, if a core API is updated, list it under “Changed” and provide migration details if necessary. For major updates, link to the source for further context.
考虑用户影响时分配类别。例如，如果核心 __CAPGO_KEEP_0__ 更新了，列出它在“更改”下，并在必要时提供迁移细节。对于重大更新，链接到源以获取更多上下文。
添加参考链接
1. 使更改日志更有帮助，通过链接到相关文档、问题或提交项:
Directly link to GitHub issues or pull requests related to the change:
- Fix iOS camera permissions dialog ([#234](https://github.com/your-repo/issues/234))2. 直接链接到 __CAPGO_KEEP_0__ 相关的问题或拉取请求:
文档链接
- 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.
顶级更改日志工具
几个工具可以有效地处理更改日志自动化。当选择一个工具时，应重点关注以下关键功能：
- 版本检测:自动识别新版本
- 提交解析:从提交消息中提取相关细节
- 集成能力:完美地融入您的现有 CI/CD pipeline
- 自定义选项: 根据您的项目的具体需求进行定制
Capgo 通过实时更新来简化 changelog 自动化 [1]. 在生产环境中有超过 750 个应用程序，23.5 万次更新已经证明了它的可靠性。为了充分利用这些工具，确保您的提交消息遵循清晰的结构 [1]提交消息标准
使用以下格式撰写提交消息:
[可选正文]
[可选尾注]
以下是常见的提交类型:
feat
- : 为引入新功能feat : 为引入新功能
- 修复: 用于解决bug
- 文档: 用于文档变更
- 格式化: 用于格式化更新
- 重构: 用于重构code而不改变其行为
- 测试: 用于添加或更新测试
- 任务: 用于一般性维护任务
CI/CD Changelog Setup
通过结合自动化工具与标准化的提交信息，您可以将 changelog 生成集成到 CI/CD pipeline 中。这一设置确保了快速准确的更新。正确配置的 pipeline 可以自动生成 changelog、检查消息格式、更新文档以及通知您的团队。
结果自说自话：95% 的活跃用户在 24 小时内使用 Capgo 的自动部署系统接收更新 [1].
OTA 更新 Changelog 管理
处理 OTA 更新的 changelog 需要额外的关注，因为这些更新会立即部署。与用户下载手动的传统应用商店更新不同，OTA 更新会自动到达设备。这使得清晰详细的文档对于维持用户信任并确保透明度至关重要。
OTA 更新文档
当管理实时更新时，重要的是要记录关键细节，如 bundle 版本、OTA 更新版本、部署时间戳、成功率和用户采用度指标。为了使 changelog 易于理解，请将更新组织成清晰的类别：
| 类别 | 描述 | 示例条目 |
|---|---|---|
| 关键修复 | 紧急修复立即问题 | “修复用户认证流程中的崩溃” |
| 功能更新 | 新功能或改进 | “为仪表盘添加了暗色模式支持” |
| 性能 | 页面/区域: 首页问题/解决方案部分。角色: 部分或页面标题。见于: 页面premium-support.astro。消息键`ps_help_performance_title` (Ps Help Performance Title)。 | 速度和优化改进 |
| “通过40%减少了应用程序加载时间” | 安全性 | 页面/区域: 企业产品/价格页面。角色: UI标签。见于: 页面enterprise.astro。消息键`enterprise_hero_security_label` (Enterprise Hero Security Label)。 |
Capgo “增强了文件传输的数据加密”
实时OTA更新需要详细的文档来补充您的总体更改日志策略。 Capgo 简化了此过程，自动跟踪版本，监控更新性能，记录回滚，记录部署到频道。
一位管理超过5,000名用户的开发者分享了他们的经历：
“我们在生产环境中部署了 Capgo OTA更新，用户数量超过5000。我们看到的操作非常Smooth几乎所有用户在OTA部署到@Capgo后几分钟内就已经更新了。” – colenso [1]
实时OTA更改日志管理最佳实践:
- 尽快记录更改。
- 按频道跟踪更新以支持分阶段部署。
- 保持回滚记录以快速解决问题。
罗德里戈·曼蒂卡强调了这种方法的重要性：
“我们实行敏捷开发，@Capgo 对于持续向用户交付至关重要！” – 罗德里戈·曼蒂卡 [1]
总结
更改日志管理的关键实践
有效的更改日志管理提高了清晰度并增强了用户信任。以下是一些基本实践:
| 实践 | 描述 | 影响 |
|---|---|---|
| 版本跟踪 | 跟踪应用程序和OTA版本号 | 82%的全球成功率 [1] |
| 更新类别 | 按类型（修复、功能、安全）分类更新 95%的活跃用户在24小时内更新 | 部署记录 [1] |
| 部署记录 | 记录时间戳、成功率和指标。 | 支持监控 2,350万次更新。 [1] |
| 回滚策略 | 通过OTA集成维护之前版本的日志。 | 允许在必要时立即恢复。 |
建议的工具
为了有效地实施这些实践，使用正确的工具至关重要。现代Capacitor应用程序将从工具Capgo中受益，后者简化了更改日志管理，具有以下功能：
- 自动化版本控制：通过CI/CD管道无缝跟踪和记录更新。
- 实时分析：实时监控更新性能和用户采用率。
- 频道管理：启用beta测试和分阶段发布以实现 smoother部署。
选择changelog管理工具时，优先考虑：
- 无缝集成context:Capgo营销网站。角色：短UI标签或导航项。消息键`seamless_integration`（无缝集成）。
- ：与您的现有工作流程兼容。详细文档
- ：自动跟踪部署数据。用户更新
：清晰直接的关于变化的通信。
“We practice agile development and @Capgo is mission-critical in delivering continuously to our users!” [1]
“我们实践敏捷开发，@Capacitor在持续交付给用户方面是 mission-critical！”
继续阅读__CAPGO_KEEP_0__ Changelog管理： ultimate指南。 Capacitor 日志管理：最终指南 为了计划回滚和版本控制，连接它与 回滚 回滚的实施细节中 版本目标 在页面/区域：Capgo解决方案营销页面。角色：部分或页面标题。见于：页面解决方案/版本目标.astro。消息键`解决方案_版本目标_标题`（解决方案版本目标标题）。|在页面/区域：Capgo解决方案营销页面。角色：短UI标签或导航项。见于：页面解决方案/版本目标.astro。消息键`解决方案_版本目标`（解决方案版本目标）。 版本目标的实施细节中 更新行为 更新行为的实施细节中 捆绑 Capgo Live Updates Capgo 实时更新
