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

有关详细信息，请参阅：