Automatically generated release notes

You can automatically generate release notes for your GitHub releases

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

About automatically generated release notes

Automatically generated release notes provide an automated alternative to manually writing release notes for your GitHub releases. With automatically generated release notes, you can quickly generate an overview of the contents of a release. You can also customize your automated release notes, using labels to create custom categories to organize pull requests you want to include, and exclude certain labels and users from appearing in the output.

Creating automatically generated release notes for a new release

  1. 在 GitHub.com 上,导航到仓库的主页面。

  2. To the right of the list of files, click Releases. 右侧边栏中的 Releases(发行版)部分

  3. 单击 Draft a new release(草拟新发行版)发行版草稿按钮

  4. Click Choose a tag and type a version number for your release. Alternatively, select an existing tag.

    Enter a tag

  5. If you are creating a new tag, click Create new tag. Confirm you want to create a new tag

  6. If you have created a new tag, use the drop-down menu to select the branch that contains the project you want to release. Choose a branch

  7. To the top right of the description text box, click Auto-generate release notes. Auto-generate release notes

  8. Check the generated notes to ensure they include all (and only) the information you want to include.

  9. (可选)要在发行版中包含二进制文件(例如已编译的程序),请在二进制文件框中拖放或手动选择文件。 通过发行版提供 DMG

  10. 要通知用户发行版本尚不可用于生产,可能不稳定,请选择 This is a pre-release(这是预发布)将版本标记为预发行版的复选框

  11. (可选)选择 Create a discussion for this release(为此版本创建讨论),然后选择 Category(类别)下拉菜单,然后点击类别进行版本讨论。 用于创建发行版讨论和下拉菜单以选择类别的复选框

  12. 如果您准备推广您的发行版,请单击 Publish release(发布版本)。 要在以后处理该发行版,请单击 Save draft(保存草稿)发布版本和草拟发行版按钮

Configuring automatically generated release notes

  1. 在 GitHub.com 上,导航到仓库的主页面。
  2. 在文件列表上方,使用 Add file(添加文件)下拉菜单,单击 Create new file(创建新文件)"添加文件"下拉菜单中的"创建新文件"按钮
  3. In the file name field, type .github/release.yml to create the release.yml file in the .github directory. Create new file
  4. In the file, using the configuration options below, specify in YAML the pull request labels and authors you want to exclude from this release. You can also create new categories and list the pull request labels to be included in each of them.

配置选项

Parameter描述
changelog.exclude.labelsA list of labels that exclude a pull request from appearing in release notes.
changelog.exclude.authorsA list of user or bot login handles whose pull requests are to be excluded from release notes.
changelog.categories[*].titleRequired. The title of a category of changes in release notes.
changelog.categories[*].labelsRequired. Labels that qualify a pull request for this category. Use * as a catch-all for pull requests that didn't match any of the previous categories.
changelog.categories[*].exclude.labelsA list of labels that exclude a pull request from appearing in this category.
changelog.categories[*].exclude.authorsA list of user or bot login handles whose pull requests are to be excluded from this category.

示例配置

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:
        - "*"

延伸阅读

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。