弃用
Hugo 项目遵循正式且一致的流程来弃用函数、方法和配置设置。
当项目_弃用_某些内容时,他们是在告诉用户:
- 不再使用事物一。
- 改用事物二。
- 我们将在未来的某个时候移除事物一。
常见的 弃用原因:
- 某个功能已被更强大的替代方案取代。
- 某个功能存在设计缺陷。
- 某个功能被认为是多余的,将在未来被移除以简化整个系统。
- 软件的未来版本将进行重大结构调整,使得支持旧功能变得不可能或不切实际。
- 命名标准化或提高一致性。
- 曾经只能独立使用的功能现在与其配套功能合并。
项目团队在代码中弃用某些内容后,Hugo 将:
- 在 3 个次版本发布期间记录 INFO 消息1
- 在接下来的 12 个次版本发布期间记录 WARN 消息
- 此后记录 ERROR 消息并使构建失败
项目团队将:
- 在弃用日期,更新文档,添加说明弃用内容和相关替代方案的注释。
- 在 Hugo 开始记录 ERROR 消息并使构建失败后的六个或更多次版本发布后移除代码。届时,Hugo 将抛出错误,但错误消息将不再提及弃用。
- 在弃用日期两年后移除相应的文档。
要查看 INFO 消息,必须使用 --logLevel 命令行标志:
hugo --logLevel info要将输出限制为仅弃用通知:
hugo --logLevel info | grep deprecate每次升级 Hugo 时都运行上述命令。
-
例如,v0.1.1 => v0.2.0 是一个次版本发布。 ↩︎