使用 GitHub 自動化版本資訊

已完成

了解如何在存放庫中建立和管理版本標記後,您將學習如何設定從 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. 嘗試建立新版本,然後按一下 [+ 自動產生版本資訊],查看範本結構。

如需詳細資訊,請參閱