使用 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. 尝试创建新版本，并单击“+ 自动生成发行说明”，以查看模板结构。

有关详细信息，请参阅：