使用 GitHub 將版本資訊自動化

  • 5 分鐘

瞭解如何在存放庫中建立和管理發行標籤之後，您將瞭解如何為 GitHub 發行設定自動產生的發行資訊。

您可以建立版本中包含的內容概觀，也可以自訂自動版本註記。

您可以使用標籤來建立自訂類別來組織提取請求。 您也可以選擇在輸出中包含或排除特定標籤和使用者。

建立自動產生的版本資訊

設定發行版本時，您可以選擇「自動生成發行說明」，以包括您的標籤與上一個發行版本之間的所有變更。 如果您之前從未建立過版本，則它會包含存放庫中的所有變更。

如何從 GitHub 建立版本資訊的螢幕快照。

您可以選擇自訂它或保持原樣。

設定自動產生的版本發行說明範本

您可以按照以下步驟自訂自動產生的發行說明範本：

  1. 移至您的存放庫並建立新檔案。

    如何在 GitHub 上建立新檔案的螢幕快照。

  2. 使用名稱 .github/release.yml 在 .github 目錄中建立release.yml檔案。

    如何在 GitHub 上建立release.yml檔案的螢幕快照。

  3. 以 YAML 格式寫入，這會提取您想要從此版本排除的要求標籤和作者。 您也可以建立新的類別，並列出每個中的提取要求標籤。 如需設定選項的詳細資訊，請參閱 自動產生的版本資訊 - GitHub Docs。

    範例設定：

    # .github/release.yml

changelog:
  exclude:
    labels:
    - ignore-for-release
    authors:
    - octocat
  categories:
    - title: Breaking Changes 🛠
      labels:
        - Semver-Major
        - breaking-change
    - title: Exciting New Features 🎉
      labels:
        - Semver-Minor
        - enhancement
    - title: Other Changes
      labels:
        - *

  4. 提交您的新檔案。

    在 GitHub 上提交新檔案的螢幕截圖。

  5. 嘗試建立新版本，然後選取 + 自動產生版本資訊 ，以查看範本的運作方式。

如需詳細資訊，請參閱：