Release note 產生器

把 commit 或任務條列整理成 Added、Changed、Fixed 與 Notes。

輸入內容只在瀏覽器本機處理。 feat 進 Added、fix 進 Fixed、change/refactor 進 Changed;chore、docs 與其他 prefix 進 Notes。

使用說明

把 commit 或任務條列整理成 Added、Changed、Fixed 與 Notes。

軟體版本更新時,手寫更新日誌(Changelog)總是要花大半天整理 Git 紀錄嗎?只要貼上常規提交紀錄(Conventional Commits,如 feat、fix、perf、docs),本工具一秒自動分類為「新功能」、「修復錯誤」、「效能提升」等清晰結構,產出專業的 Release Notes!

💡 3 步驟快速上手

① 貼上 Git Commit 紀錄

將近期專案的 Git Commit 訊息一筆一行貼入輸入框中。

② 自動解析與分類

工具依據業界規範自動辨識 feat(功能)、fix(錯誤修復)、refactor(重構)等前綴。

③ 一鍵匯出 Markdown 更新公告

一秒生成排版精美的 Markdown 格式版本更新發布說明,直接貼在 GitHub Release 或公告發送!

適用情境

適合產品更新、客戶公告與內部交接。

計算或處理方式

feat 進 Added、fix 進 Fixed、change/refactor 進 Changed;chore、docs 與其他 prefix 進 Notes。

具體範例

範例:feat、fix、change、chore 清單轉成發布摘要。

限制與資料處理

輸出是 Markdown 草稿,發布前仍應確認名稱、版本與使用者影響。

不會。內容在瀏覽器內分組,分析只記錄工具代號。

語意化版本 SemVer、Keep a Changelog 與軟體發布日誌指南

一、語意化版本(Semantic Versioning 2.0.0)核心規範

在軟體工程與套件相依性管理中,全球通用的語意化版本(SemVer 2.0.0)採用 `MAJOR.MINOR.PATCH`(主版本號.次版本號.修訂號)的三位數字格式:

1. MAJOR(主版本號):當發生「不向下相容的重大 API 變更(Breaking Change)」時遞增。

2. MINOR(次版本號):當以「向下相容的方式新增功能(Feature)」時遞增。

3. PATCH(修訂號):當以「向下相容的方式修復錯誤(Bug Fix)」時遞增。

遵循嚴格的 SemVer 規範能讓開發團隊與套件使用者清楚掌握每次升級的潛在相容性風險。

二、Keep a Changelog 國際變更日誌分類標準

依據開源社群推崇的「Keep a Changelog」標準,一份優質的發布日誌應將更新項目依受眾角度分類為:

・Added(新增):新加入的功能或特性。

・Changed(變更):現有功能的行為修改。

・Deprecated(棄用):即將在未來主版本中移除的功能警告。

・Removed(移除):在此版本中已正式刪除的功能。

・Fixed(修復):已解決的軟體缺陷與 Bug。

・Security(安全):修補的安全漏洞與相依套件升級。

三、面向不同受眾的發布日誌溝通藝術

發布日誌可分為「面向開發者的技術日誌(Technical Changelog)」與「面向終端使用者的產品更新公告(User-Facing Release Notes)」。後者應避免深奧的內部代碼提交紀錄,轉而以簡潔生動的語言說明「這項新功能為使用者解決了什麼問題」、「如何開始體驗」,並附上操作指引。

權威資料來源與參考規範

  • Semantic Versioning 2.0.0 語意化版本規範(Tom Preston-Werner)
  • Keep a Changelog 國際變更日誌指南(Olivier Lacan)
  • GitHub Documentation: Managing Releases in a Repository

常見問題

Release note 產生器要輸入什麼?

每行一筆 commit 或任務,支援 feat、fix、chore 等常見 prefix。

Release note 產生器如何分到各章節?

feat 進 Added、fix 進 Fixed、change 與 refactor 進 Changed;chore、docs 與其他 prefix 進 Notes。

Release note 產生器的結果可以直接發布嗎?

輸出是 Markdown 草稿,發布前仍應確認名稱、版本與使用者影響。

Release note 產生器會上傳 commit 內容嗎?

不會。內容在瀏覽器內分組,分析只記錄工具代號。