使用 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. 尝试创建新版本，然后选择“ + 自动生成发行说明 ”以查看模板的工作原理。

有关详细信息，请参阅：