棄用
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 是一個次版本發布。 ↩︎