{"meta":{"title":"自动生成的发行说明","intro":"可以为GitHub版本自动生成发行说明","product":"存储库","breadcrumbs":[{"href":"/zh/repositories","title":"存储库"},{"href":"/zh/repositories/releasing-projects-on-github","title":"发布项目"},{"href":"/zh/repositories/releasing-projects-on-github/automatically-generated-release-notes","title":"自动发布说明"}],"documentType":"article"},"body":"# 自动生成的发行说明\n\n可以为GitHub版本自动生成发行说明\n\n## 关于自动生成的发行说明\n\n自动生成的发行说明为您的 GitHub 发行版提供了一种无需手动编写的自动化替代方案。 使用自动生成的发行说明，您可以快速生成发行版内容的概览。 自动生成的发行说明包括合并的拉取请求列表、发布参与者列表和完整更改日志的链接。\n\n您还可以自定义自动生成的发行说明，通过标签创建自定义类别来整理要包含的拉取请求，并排除某些标签和用户使其不出现在输出中。\n\n## 为新版本创建自动生成的发行说明\n\n1. 在 GitHub 上，导航到存储库的主页面。1. 在文件列表右侧，单击“发布”。\n\n 1. 在页面顶部，单击“起草新版本”。\n2. 若要为该版本选择标记，请选择“选择标记”下拉菜单。\n * 若要使用现有标记，请单击该标记。\n * 若要创建新标记，请键入该版本的版本号，然后单击“创建新标记”。\n3. 如果已创建新标记，请选择“目标”下拉菜单，然后单击包含要发布的项目的分支。1. （可选）在说明字段上方，选择“上一个标记”下拉菜单，然后单击标识上一版本的标记。\n\n 1. 在“发布标题”字段中，键入发布的标题。\n4. 在说明字段上方，单击“**生成发行说明**”。\n5. 检查生成的注释，确保它们包含所有（且仅有）您要包含的信息。\n6. （可选）要在发行版中包含二进制文件（例如已编译的程序），请在二进制文件框中拖放或手动选择文件。\n7. （可选）若要通知用户发行版尚未准备投入生产，并且可能不稳定，请选择“这是预发行版”。\n8. （可选）选择“设置为最新版本”。 如果未选择此选项，系统会根据语义版本控制自动分配最新版本标签。\n9. （可选）如果为存储库启用了 GitHub Discussions，请为发行版创建讨论。\n * 选择**为此发行版创建讨论**。\n * 选择“类别”下拉菜单，然后单击某个类型进行发行版讨论。\\*\\*\\*\\*\n10. 如果已准备好公开发行版，请单击“发布发行版”。 若要稍后处理版本，请单击“ **保存草稿**”。如果为存储库启用了不可变版本，请先创建草稿，以便在发布变为不可变之前附加所有资产。\n 然后可以在存储库的发行版源中查看发布的或草拟的发行版。 有关详细信息，请参阅“[查看仓库的发行版和标记](/zh/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags)”。\n\n## 配置自动生成的发行说明\n\n1. 在 GitHub 上，导航到存储库的主页面。1. 在文件列表上方，选择“Add file” 下拉菜单，然后单击“ Create new file”\\*\\*\\*\\*\\*\\*\\*\\*。\n\n 也可在左侧的文件树状视图中单击 。\n\n \n2. 在“文件名”字段中，键入 `.github/release.yml`。 这会在 `release.yml` 目录中创建名为 `.github` 的新文件。\n3. 在文件中，使用下面的配置选项，在 YAML 中指定要从此版本中排除的拉取请求标签和作者。 您还可以创建新类别并列出要包含在每个类别中的拉取请求标签。\n\n### 配置选项\n\n| 参数 | 说明 |\n| :----------------------------------------------------- | :----------------------------- |\n| `changelog.exclude.labels` | 不在发行说明中显示拉取请求的标签列表。 |\n| `changelog.exclude.authors` | 要从发行说明中排除其拉取请求的用户或自动程序登录句柄的列表。 |\n| `changelog.categories[*].title` | |\n| **必填。** 发行说明中更改类别的标题。 | |\n| `changelog.categories[*].labels` | |\n| **必填。** 符合此类别的拉取请求条件的标签。 使用 `*` 作为与上述任何类别都不匹配的拉取请求的统称。 | |\n| `changelog.categories[*].exclude.labels` | 不在此类别中显示拉取请求的标签列表。 |\n| `changelog.categories[*].exclude.authors` | 要从此类别中排除其拉取请求的用户或自动程序登录句柄的列表。 |\n\n### 示例配置\n\n标记 SemVer 版本的存储库配置\n\n```yaml copy\n# .github/release.yml\n\nchangelog:\n exclude:\n labels:\n - ignore-for-release\n authors:\n - octocat\n categories:\n - title: Breaking Changes 🛠\n labels:\n - Semver-Major\n - breaking-change\n - title: Exciting New Features 🎉\n labels:\n - Semver-Minor\n - enhancement\n - title: Other Changes\n labels:\n - \"*\"\n```\n\n不标记拉取请求但我们希望在发行说明中分离 Dependabot 自动拉取请求的存储库的配置（`labels: '*'` 需要显示 catchall 类别）\n\n```yaml copy\n# .github/release.yml\n\nchangelog:\n categories:\n - title: 🏕 Features\n labels:\n - '*'\n exclude:\n labels:\n - dependencies\n - title: 👒 Dependencies\n labels:\n - dependencies\n```\n\n## 其他阅读材料\n\n* [管理标签](/zh/issues/using-labels-and-milestones-to-track-work/managing-labels)"}