Skip to main content

自动生成的发行说明

您可以为 GitHub 版本自动生成发行说明

Who can use this feature

Repository collaborators and people with write access to a repository can generate and customize automated release notes for a release.

关于自动生成的发行说明

自动生成的发行说明为 GitHub 发行版手动编写发行说明提供了一种自动替代方法。 使用自动生成的发行说明,您可以快速生成发行版内容的概览。 自动生成的发行说明包括合并的拉取请求列表、发布参与者列表和完整更改日志的链接。

您还可以自定义自动发行说明,使用标签创建自定义类别来组织要包含的拉取请求,并排除某些标签和用户不出现在输出中。

为新版本创建自动生成的发行说明

  1. On your GitHub Enterprise Server instance, navigate to the main page of the repository. 1. 在文件列表右侧,单击“发布”。 右侧边栏中的“发布”部分
  2. 单击“草拟新发行版”。 发行版草稿按钮
  3. 键入发行版的版本号。 或者,选择现有标记。 发行版标记的版本
  4. 如果已创建新标记,请使用下拉菜单选择包含要发布的项目的分支。 发行版标记的分支
  5. 在说明文本框右上角,单击“自动生成发行说明”。自动生成发行说明
  6. 检查生成的注释,确保它们包含所有(且仅有)您要包含的信息。
  7. (可选)要在发行版中包含二进制文件(例如已编译的程序),请在二进制文件框中拖放或手动选择文件。 通过发行版提供 DMG
  8. 若要通知用户发行版尚未准备投入生产,并且可能不稳定,请选择“这是预发行版”。 用于将发行版标记为预发行版的复选框
  9. 如果已准备好公开发行版,请单击“发布发行版”。 若要稍后处理发行版,请单击“保存草稿”。 “发布发行版”和“草拟发行版”按钮

配置自动生成的发行说明

  1. On your GitHub Enterprise Server instance, navigate to the main page of the repository. 1. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。 “添加文件”下拉列表中的“创建新文件”
  2. 在文件名字段中,键入 .github/release.yml 以在 .github 目录中创建 release.yml 文件。 新建文件
  3. 在文件中,使用下面的配置选项,在 YAML 中指定要从此版本中排除的拉取请求标签和作者。 您还可以创建新类别并列出要包含在每个类别中的拉取请求标签。

配置选项

参数说明
changelog.exclude.labels不在发行说明中显示拉取请求的标签列表。
changelog.exclude.authors要从发行说明中排除其拉取请求的用户或自动程序登录句柄的列表。
changelog.categories[*].title必填。 发行说明中更改类别的标题。
changelog.categories[*].labels必填。 符合此类别的拉取请求条件的标签。 使用 * 作为与上述任何类别都不匹配的拉取请求的统称。
changelog.categories[*].exclude.labels不在此类别中显示拉取请求的标签列表。
changelog.categories[*].exclude.authors要从此类别中排除其拉取请求的用户或自动程序登录句柄的列表。

配置示例

YAML
# .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:
        - "*"

延伸阅读