實作變更日誌

  • 3 分鐘

變更日誌很簡單：它是一個列出對專案所做的更改的文件，通常按日期組織。 一般格式會顯示版本，而每個版本會列出：

  • 新增功能 - 您可以執行的新操作
  • 修改/改進的功能 - 效果更好的東西
  • 已刪除的功能 - 已刪除的項目

有些團隊將變更日誌作為部落格文章發布。 其他人則在其 GitHub 儲存庫中建立 CHANGELOG.md 檔案。

自動變更日誌工具

雖然您可以手動建立和維護變更日誌，但您可能需要使用自動化工具來幫助您。 至少作為起點。

使用原生 Git 命令

此 git log 指令可協助您自動建立內容。 例如，為每個版本建立一個新區段：

git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y

Git 變更記錄

一種流行的工具是 gitchangelog。 這個工具是用 Python 編寫的。

GitHub 變更記錄產生器

另一個流行的工具稱為 github-changelog-generator。

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

該工具基於 Ruby Gem。

您應該使用自動產生的記錄型資料嗎？

通常最好避免僅將日誌條目複製到變更日誌中。 日誌包含太多技術細節，因此很容易造成令人困惑的混亂，無法幫助用戶了解更改的內容。