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. Automatically generated release notes include a list of merged pull requests, a list of contributors to the release, and a link to a full changelog.
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.
On GitHub.com, navigate to the main page of the repository.
To the right of the list of files, click Releases.
Click Draft a new release.
Click Choose a tag and type a version number for your release. Alternatively, select an existing tag.
If you are creating a new tag, click Create new tag.
If you have created a new tag, use the drop-down menu to select the branch that contains the project you want to release.
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.
To the top right of the description text box, click Generate release notes.
Check the generated notes to ensure they include all (and only) the information you want to include.
Optionally, to include binary files such as compiled programs in your release, drag and drop or manually select files in the binaries box.
To notify users that the release is not ready for production and may be unstable, select This is a pre-release.
Optionally, select Create a discussion for this release, then select the Category drop-down menu and click a category for the release discussion.
If you're ready to publicize your release, click Publish release. To work on the release later, click Save draft.
- On GitHub.com, navigate to the main page of the repository.
- Above the list of files, using the Add file drop-down, click Create new file.
- In the file name field, type
.github/release.ymlto create the
release.ymlfile in the
- 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.
|A list of labels that exclude a pull request from appearing in release notes.|
|A list of user or bot login handles whose pull requests are to be excluded from release notes.|
|Required. The title of a category of changes in release notes.|
|Required. Labels that qualify a pull request for this category. Use |
|A list of labels that exclude a pull request from appearing in this category.|
|A list of user or bot login handles whose pull requests are to be excluded from this category.|
A configuration for a repository that labels semver releases
# .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: - "*"
A configuration for a repository that doesn't tag pull requests but where we want to separate out Dependabot automated pull requests in release notes (
labels: '*' is required to display a catchall category)
# .github/release.yml changelog: categories: - title: 🏕 Features labels: - '*' exclude: labels: - dependencies - title: 👒 Dependencies labels: - dependencies