實作 Git 歷程記錄文件的自動化

3 分鐘

自動化發佈 Git 認可歷程記錄、版本資訊和 API 文件，可簡化為軟體專案建置完整且最新發行文件的程序。這可協助開發人員追蹤及傳達每個版本引入的變更，並促進透明度和共同作業。

自動產生 API 文件可確保其與程式碼變更的同步處理，為開發人員提供存取 API 及其功能的準確資訊。將 Git 歷程記錄摘要併入發行文件中，可提供額外的內容和可追蹤性、促進無摩擦發行週期，以及改善整體專案管理。這些自動化工作會一起最佳化文件工作流程、節省時間和精力，同時提升發行文件的品質和一致性。

實作這項功能的程序可以分成下列活動。

自動化 API 文件產生

使用 OpenAPI (先前稱為 Swagger) 或其他 API 文件工具，從程式碼基底自動產生 API 文件。將此程序整合到 CI/CD 管線，以確保 API 文件已更新並反映 API 端點的最新變更。或者，請考慮 Swagger Codegen 或 Redocly 之類的工具，從 OpenAPI 規格檔案或程式碼註釋自動產生 API 文件。

從 Git 歷程記錄產生版本資訊

使用 Git 命令或 GitChangelog 之類的工具，從 Git 認可歷程記錄自動產生版本資訊。這牽涉到剖析認可訊息及擷取相關資訊，例如新增功能和修正錯誤。自訂版本資訊格式，以包含詳細資料，例如認可作者、時間戳記、認可訊息，以及相關聯的提取要求或問題。

在版本文件中包含 Git 歷程記錄

將 Git 歷程記錄摘要或變更記錄併入您的發行文件，以及版本資訊和 API 文件。這會針對每個版本中引入的變更提供額外的內容和透明度。使用 Markdown 或其他文件格式，以清楚且容易理解的方式建構及呈現 Git 歷程記錄。

將版本資訊整合到文件管線中

將版本資訊的產生整合到文件管線或 CI/CD 工作流程中。這可確保每當標記新版本或產生版本時，版本資訊都會自動更新並包含在您的發行文件中。使用 Azure Pipelines 或 GitHub Actions 之類的指令碼或自動化工具，在文件建置程序中觸發版本資訊的產生。

自動化文件發佈