工程開發
release-notes-generator avatar

release-notes-generator

自動化 Git 提交紀錄發佈說明生成工具。自動分類變更內容,將技術語言轉換為用戶友善訊息,並支援生成 CHANGELOG.md、PR 說明與 Slack 公告。

簡介

發佈說明生成器 (Release Notes Generator) 是一款專為簡化軟體發佈流程而設計的自動化工具,能將原始的 git 提交記錄轉換為結構化且具備高度參考價值的說明文件。對於希望在不增加手動撰寫負擔的情況下,與利害關係人、產品經理及終端用戶保持高品質溝通的開發團隊而言,這是理想的解決方案。透過與您的 git 工作流程及 GitHub API 直接整合,該工具可分析自上次發佈標籤以來的歷史記錄,將變更精準分類為新功能、錯誤修復、效能改善與安全性更新,並進一步將資訊濃縮為三種格式:技術性 CHANGELOG.md、半技術性的 PR 說明主體,以及用戶友善的 Slack 公告。

  • 使用 Conventional Commits 前綴(如 feat, fix, perf, security)自動分類變更內容

  • 將技術術語(例如將 'N+1 query optimization' 轉換為 'Faster list loading')自動翻譯為非技術人員可理解的語言

  • 透過檢查 git diff 中的遷移目錄來檢測資料庫遷移,並在控制台輸出關鍵警示

  • 透過 gh api 獲取 PR 標題、描述與標籤等豐富資料,以增強內容情境

  • 確保在多個管道中輸出內容的一致性,以維護開發人員與產品團隊之間的同步

  • 支援自定義 Slack 公告與 PR 發佈模板

  • 於儲存庫根目錄執行此技能,可產生自上次標籤或特定版本區間以來的發佈說明

  • 需配置已驗證的 GitHub CLI (gh) 以存取 PR 中繼資料

  • 建議搭配標準化的 Conventional Commits 格式以獲得最佳的分類效果

  • 提供預覽模式,在將文件寫入磁碟前先確認輸出內容

  • 在發布至公共頻道前,請務必審閱生成的內容以確保語氣精確

  • 可處理複雜的輸出邏輯,包含每個版本的統計數據整合(如 PR、功能與錯誤修正的數量)

倉庫統計

Star 數
4,082
Fork 數
537
Open Issue 數
5
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月1日 上午07:53
在 GitHub 查看