管理日志对于保持您的 应用程序更新 以透明和有条理的方式。 本指南解释了如何为 Capacitor 应用程序创建、结构化和自动化日志
- 确保开发者和用户都能得到通知。 以下是您将要学习的内容：为什么日志重要
- ：它们简化了调试、改善了沟通和建立了用户信任。如何结构化日志
- ：使用类别，如“添加”，“修复”和“安全性”以提高清晰度。最佳实践 Capgo__CAPGO_KEEP_0__
- 自动化日志，并在拉取请求期间审查条目。: 使用 CI/CD pipeline 和提交标准来简化 changelog 管理。
- OTA 更新: 使用详细信息，如版本号、时间戳和成功率，记录实时更新。
快速提示: 使用工具如 Capgo 来自动化 changelog 创建，节省时间并确保一致性。使用 Over-the-Air (OTA) 解决方案，95% 的用户在 24 小时内更新。
深入指南中了解如何设置第一个 changelog 并将其无缝地集成到您的工作流中。
如何自动化项目的版本号和 changelog 到 …
设置您的第一个 changelog
为您的 Capacitor 应用创建清晰的 changelog 至关重要，以便跟踪和分享更新。以下是如何有效地结构它并遵循最佳实践。
changelog 格式选项
遵循 __CAPGO_KEEP_0__ __CAPGO_KEEP_1__
| __CAPGO_KEEP_2__ | __CAPGO_KEEP_3__ | __CAPGO_KEEP_4__ |
|---|---|---|
| __CAPGO_KEEP_5__ | __CAPGO_KEEP_6__ | __CAPGO_KEEP_7__ |
| __CAPGO_KEEP_8__ | __CAPGO_KEEP_9__ | __CAPGO_KEEP_10__ |
| __CAPGO_KEEP_11__ | 即将移除的功能 | 即将废弃的遗留API端点 |
| 已移除 | 已移除的功能 | 已移除过时的分析 |
| 已修复 | 修复了 iOS 相机权限 | 安全 |
| 安全更新 | 增强数据加密 | 构建您的 CHANGELOG.md |
为您的应用程序增强安全性
To set up your __CAPGO_KEEP_0__ project, ensure it’s consistently organized and easy to read. Place it in the root directory of your project and include these main elements: CHANGELOG.mdHeader Section
- : 在这里添加您的项目名称和简要描述。Version Blocks
- : 使用语义版本号 (MAJOR.MINOR.PATCH) 来记录更新。Release Dates
- : 使用 ISO 格式 (YYYY-MM-DD) 来记录发布日期，例如Change Categories
2025-03-27. - : 根据适当的标题来分组更新。Always list versions in reverse chronological order so the newest updates are at the top.
Adding Changelog Steps to Development
__CAPGO_KEEP_1__
在工作流中整合 changelog 更新确保了准确和最新的文档。以下是一些实用的提示：
- 提交前更新：在提交 code 变更之前更新 changelog。这样可以减少遗漏重要更新的机会。
- 自动集成：像 Capgo 这样的工具与 GitHub Actions, GitLab CI，和 Jenkins [1] 一起工作，简化了更新 changelog 的过程。
- 审查流程：将审查 changelog 条目作为您的 pull 请求流程的一部分。这样可以确保更新准确且经过批准之前合并。
Writing Clear Changelog Entries
Changelog entries should strike a balance between technical precision and readability, making them useful for both developers and users.
Writing Style Guide
Stick to these principles to ensure your changelog entries are clear and consistent:
- Write in present tense
- Begin with action verbs
- Be specific about what has changed
- Mention updates to dependency versions
- 使用最少的技术术语
示例：
| 不明确的入口 | 清晰的入口 |
|---|---|
| 修复了bug | 修复iOS 17.4设备上的摄像头预览冻结问题 |
| 添加了内容 | 为Android添加生物识别验证支持 |
| 修改了API | 更新用户资料端点以支持新字段 |
| 安全修复 | 补丁 SQLite __CAPGO_KEEP_0__ |
Change Types and Categories
让用户快速找到他们关心的内容，组织更新分类。常见分类包括：
- Added: 引入新功能或功能
- Changed: 更新或修改现有功能
- Deprecated: 标记计划移除的功能或功能
- Removed: 表示已被移除的功能或功能
- 修复: 解决bug或问题
- 安全: 涵盖与安全漏洞相关的补丁或更新
在分配类别时考虑用户的影响。例如，如果核心API更新了，列出它在“更改”下，并提供必要的迁移细节。对于重大更新，链接到源以获取更多上下文。
添加参考链接
通过链接到相关文档、问题或提交，使您的更改日志更有帮助：
1. 问题参考
直接链接到GitHub问题或pull请求相关的更改：
- 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. 提交参考
For major updates, reference the specific commit:
- Update authentication flow (commit: `8f4d89b`)“Capgo 是开发者必备工具，希望提高工作效率的开发者都应该使用它。避免 bugfix 的审查是黄金的.” - Bessie Cooper
Changelog 自动化工具
通过自动化 changelog 的创建，简化了您的工作流程，并确保了项目的 Capacitor 变更记录的一致性。
顶级 changelog 工具
几个工具可以有效地处理 changelog 自动化。选择其中一个时，应重点关注以下关键功能:
- 版本检测: 自动检测新版本
- 提交解析: 从提交消息中提取相关细节
- 集成能力: 与您的现有 CI/CD pipeline 完美集成
- 自定义选项: 根据您的项目的具体需求进行定制
Capgo 通过实时更新来简化 changelog 自动化 [1]. 有超过 750 个应用程序在生产环境中运行，23.5 万次更新已成功交付 [1], 这表明其可靠性。要充分利用这些工具，确保您的提交消息遵循清晰的结构。
提交消息标准
使用以下格式撰写提交消息：
[可选正文]
[可选尾注]
以下是常见的提交类型：
- feat: 用于引入新功能
- 修复：用于解决bug
- 文档：用于文档变更
- 样式：用于格式化更新
- 重构：用于重组code而不改变其行为
- 测试：用于添加或更新测试
- 构建：用于一般性维护任务
CI/CD Changelog Setup
通过结合自动化工具与标准化的提交信息，您可以将更改日志生成集成到CI/CD管道中。这种设置确保快速准确的更新。正确配置的管道可以自动生成更改日志、检查消息格式、更新文档并通知您的团队。
结果自说自话：使用Capgo的自动部署系统，95%的活跃用户在24小时内接收更新 [1].
OTA更新日志管理
处理OTA更新的日志需要额外的关注，因为这些更新会立即部署。与用户手动下载的传统应用商店更新不同，OTA更新会自动到达设备。这使得清晰详细的文档对于维持用户信任并确保透明度至关重要。
OTA更新文档
管理实时更新时，重要的是要记录关键细节，如捆绑包版本、OTA更新版本、部署时间戳、成功率和用户采用度指标。为了使日志易于理解，组织更新到清晰的类别中：
| 类别 | 描述 | 示例条目 |
|---|---|---|
| 紧急修复 | 紧急修复立即问题 | “修复用户认证流程中的崩溃” |
| 功能更新 | 新功能或改进 | “为仪表板添加了暗色模式支持” |
| 性能 | 速度和优化改进 | “通过40%减少了应用程序加载时间” |
| 安全 | 增强安全性 | “为文件传输增强了数据加密” |
Capgo 更新管理
实时OTA更新需要详细的文档来补充您的总体更改日志策略。Capgo 简化了此过程，自动跟踪版本、监控更新性能、记录回滚和按渠道记录部署。
一位管理超过5,000名用户的开发人员分享了他们的经历：
“我们在生产环境中部署了Capgo OTA更新，覆盖了超过5000名用户。我们看到的几乎所有用户在OTA部署到@Capgo后几分钟内就已经更新了。” – colenso [1]
实时OTA更改日志管理最佳实践:
- 尽快记录更改。
- 按渠道跟踪更新以支持分阶段部署。
- 快速解决问题时，保留回滚记录。
罗德里戈·曼蒂卡强调了这种方法的重要性：
“我们实行敏捷开发，@Capgo 对于持续向用户交付至关重要！” – 罗德里戈·曼蒂卡 [1]
概要
更改日志管理的关键实践
有效的更改日志管理提高了清晰度并增强了用户信任。以下是几个关键实践：
| 实践 | 描述 | 影响 |
|---|---|---|
| 版本跟踪 | 跟踪应用程序和OTA的版本号。 | 82%的全球成功率 [1] |
| 更新类别 | 按类型（修复、功能、安全）分类更新。 95%的活跃用户在24小时内更新 | 部署记录 [1] |
| __CAPGO_KEEP_0__ | 记录时间戳、成功率和指标。 | 支持监控 2,350 万次更新 [1] |
| 回滚策略 | 与 OTA 集成的 OTA 集成 | 允许在必要时立即恢复。 |
改善管理的建议工具
To implement these practices effectively, using the right tools is crucial. Modern Capacitor apps benefit from tools like Capgo, which simplifies changelog management with features such as:
- 自动化版本控制: 使用 CI/CD pipeline 一键式跟踪和记录更新
- 实时分析: 实时跟踪更新性能和用户采用率
- 频道管理: 当前安全浏览和浏览为一个安全提交。
当选择用于 changelog 管理的工具时，优先考虑：
- 无缝集成: 与您的现有工作流程兼容
- 详细文档: 自动跟踪部署数据
- 用户更新: 对用户变化进行清晰、直接的沟通
通过结合这些实践和合适的工具，您可以建立一个可靠的 changelog 系统，支持持续交付，同时保持用户知情
“我们实践敏捷开发，@Capgo 是在持续交付给用户方面至关重要的!” [1]
Keep going from Capacitor Changelog Management: Ultimate Guide
如果您正在使用 Capacitor 发布日志管理：最终指南 __CAPGO_KEEP_0__ 为计划回滚和版本控制，连接它 回滚 回滚的实施细节在 版本目标 版本目标的实施细节在 更新行为 更新行为的实施细节在 打包 打包的实施细节在 Capgo 实时更新 Capgo 实时更新中的产品工作流程。
