菜单

更新日志和版本历史

相关源文件

本页面介绍了 Font Awesome 如何跟踪和传达不同版本之间的变更。它解释了在哪里可以找到变更日志信息,如何解释版本号,并为理解项目的版本历史提供了背景。有关详细的升级说明,请参阅升级 Font Awesome,有关版本管理理念的信息,请参阅版本管理策略

变更日志文档系统

Font Awesome 使用一个专门的系统来记录版本之间的变更。

主要的变更日志位置已演变

  1. 当前方法:官方网站(在 README 和 CHANGELOG 文件中均有引用)
  2. 历史记录:GitHub Releases 页面,用于旧版本详情
  3. 存储库参考:CHANGELOG.md 文件,该文件重定向到网站

来源:README.md24-28 CHANGELOG.md1-5

版本编号和结构

Font Awesome 实施了一个修改版的语义化版本控制系统,用于规定变更的记录方式。

影响变更日志的关键版本规则

  • 主版本(6.x.x):“整合版本”,涵盖多个组件。
  • 次版本(x.Y.x):可能包含破坏性变更(附带文档)。
  • 修订版本(x.x.Z):仅限 Bug 修复,从不破坏向后兼容性。
  • 任何版本更新都可能更新图标设计,但次版本/修订版本更新绝不会移除图标。

来源:README.md49-67

版本时间线和支持状态

Font Awesome 维护多个不同支持级别的版本,这会影响变更日志条目的管理方式。

支持状态对变更日志跟踪的影响

  • 版本 6:积极开发中,具有完整的变更日志文档。
  • 版本 5:LTS(长期支持)状态,变更有限(仅限关键 Bug)。
  • 版本 3 & 4:已结束生命周期,仅包含历史变更日志。

来源:README.md14-19

变更日志访问参考表

版本主要位置次要位置更新频率
6.x (当前)官方网站-定期更新
5.x (LTS)官方网站GitHub Releases仅限关键修复
4.x 及更早版本 (EOL)GitHub Releases-无更新(历史记录)

来源:README.md26-28 CHANGELOG.md3-5

解读变更日志条目

在审阅 Font Awesome 变更日志条目时,请遵循此框架来理解其影响。

来源:README.md56-67

版本影响评估

版本变更破坏性潜力文档需要采取的行动
主版本 (X.0.0)重大变更升级指南大规模测试,代码调整
次版本 (0.X.0)可能包含破坏性变更UPGRADING.md查阅文档,测试变更
修订版本 (0.0.X)无破坏性变更仅限变更日志可直接应用

来源:README.md61-67

特定组件的变更

变更日志中记录的变更通常影响特定组件,每个组件都有不同的许可证。

来源:README.md70-79

升级资源

在利用变更日志信息进行升级规划时,Font Awesome 提供了特定资源。

  1. Web 实现:Web 升级指南,在README.md34 中引用。
  2. 桌面实现:桌面升级指南,在README.md35 中引用。

这些指南提供了详细说明,用于导航变更日志中记录的变更。

来源:README.md31-35

使用变更日志的最佳实践

  1. 在任何 Font Awesome 更新之前,请检查变更日志。
  2. 特别注意次版本更新(可能包含破坏性变更)。
  3. 在生产部署之前,请在开发环境中进行彻底测试。
  4. 在整个项目中保持一致的 Font Awesome 版本。
  5. 对于旧版本(3.x、4.x),请注意它们已结束生命周期,不再有新变更。

来源:README.md14-19 README.md56-67

历史版本发布

有关历史版本信息和过去发布的详细变更日志,GitHub Releases 页面是权威来源,尤其是对于 5.x 及更早的版本。

来源:README.md28