关于自动生成的发行说明
自动生成的发行说明为 GitHub 发行版手动编写发行说明提供了一种自动替代方法。 使用自动生成的发行说明,您可以快速生成发行版内容的概览。 自动生成的发行说明包括合并的拉取请求列表、版本贡献者列表以及指向完整更改日志的链接。
您还可以自定义自动发行说明,使用标签创建自定义类别来组织要包含的拉取请求,并排除某些标签和用户不出现在输出中。
为新版本创建自动生成的发行说明
-
在 GitHub.com 上,导航到仓库的主页面。
-
在文件列表右侧,单击 Releases(发行版)。
-
单击 Draft a new release(草拟新发行版)。
-
单击 Choose a tag(选择标记),然后键入发行版的版本号。 或者,选择现有标记。
-
如果要创建新标记,请单击 Create new tag(创建新标记)。
-
如果已创建新标记,请使用下拉菜单选择包含要发布的项目的分支。
-
Optionally, to the top right of the description text box, select the Previous tag drop-down menu and click the tag that identifies the previous release.
-
在说明文本框的右上角,单击Generate release notes(生成发行说明)。
-
检查生成的注释,确保它们包含所有(且仅有)您要包含的信息。
-
(可选)要在发行版中包含二进制文件(例如已编译的程序),请在二进制文件框中拖放或手动选择文件。
-
要通知用户发行版本尚不可用于生产,可能不稳定,请选择 This is a pre-release(这是预发布)。
-
(可选)选择 Create a discussion for this release(为此版本创建讨论),然后选择 Category(类别)下拉菜单,然后点击类别进行版本讨论。
-
如果您准备推广您的发行版,请单击 Publish release(发布版本)。 要在以后处理该发行版,请单击 Save draft(保存草稿)。
配置自动生成的发行说明
- 在 GitHub.com 上,导航到仓库的主页面。
- 在文件列表上方,使用 Add file(添加文件)下拉菜单,单击 Create new file(创建新文件)。
- 在文件名字段中,键入
.github/release.yml
以在.github
目录中创建release.yml
文件。 - 在文件中,使用下面的配置选项,在 YAML 中指定要从此版本中排除的拉取请求标签和作者。 您还可以创建新类别并列出要包含在每个类别中的拉取请求标签。
配置选项
参数 | 描述 |
---|---|
changelog.exclude.labels | 不在发行说明中显示拉取请求的标签列表。 |
changelog.exclude.authors | 要从发行说明中排除其拉取请求的用户或自动程序登录句柄的列表。 |
changelog.categories[*].title | 必需。发行说明中更改类别的标题。 |
changelog.categories[*].labels | 必需。符合此类别的拉取请求条件的标签。 使用 * 作为与上述任何类别都不匹配的拉取请求的统称。 |
changelog.categories[*].exclude.labels | 不在此类别中显示拉取请求的标签列表。 |
changelog.categories[*].exclude.authors | 要从此类别中排除其拉取请求的用户或自动程序登录句柄的列表。 |
示例配置
# .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:
- "*"
延伸阅读
- "管理标签"