工程開發
release-prep avatar

release-prep

自動化 MassGen 發布準備流程,包括生成 CHANGELOG 條目、草擬發布公告以及在 git 標記前驗證文檔完整性。

簡介

release-prep 技能是一項專門的自動化工具,旨在簡化 MassGen 儲存庫的軟體發布生命週期。它透過將繁瑣的手動文檔任務整合為單一可靠的指令,協助開發人員和發布經理在 git 標記之前完成準備工作。此技能透過分析 git 歷史記錄、提交日誌與合併請求數據,確保專案文件(包括變更日誌、README 和設定檔)在多個平台上的結構一致且保持最新狀態。

  • 自動透過解析 git 日誌和合併的拉取請求來識別自上次版本標記以來的變更。

  • 按照 Keep a Changelog 格式更新 CHANGELOG.md,明確列出新增功能、修復的錯誤以及文檔更新。

  • 將舊的發布公告存檔至 docs/announcements/archive 目錄,以維護歷史紀錄。

  • 同步核心專案文件的文檔,包括更新基於 Sphinx 的文件 (index.rst) 中的「近期發布」區塊,以及 massgen/configs/README.md 中的發布歷史。

  • 重新生成主儲存庫 README.md 中的「最新功能」區塊,確保發布亮點、使用範例和成就總結保持最新。

  • 執行驗證檢查以確保文檔連結、檔案路徑(如 .rst、.md、.yaml)以及貢獻者清單的準確性。

  • 使用時需要提供版本字串,例如:/release-prep v0.1.34。

  • 此工具最佳執行時機是在將發布 PR 合併至 main 分支之後,但在創建最終 tag 之前。

  • 它提供了關於在 LinkedIn 和 X 上更新社交媒體公告的具體說明,並考慮了字數限制與格式要求。

  • 使用者應確保擁有正確的 git 歷史存取權限,以便提取提交摘要與貢獻者統計。

  • 透過強化一致的發布說明與文檔更新,此技能減少了公開發布溝通中的人為錯誤,並有助於維持高品質的專案可見度。

倉庫統計

Star 數
968
Fork 數
151
Open Issue 數
6
主要語言
Python
預設分支
main
同步狀態
閒置
最近同步時間
2026年4月29日 上午07:09
在 GitHub 查看