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.
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.
To the top right of the description text box, click Auto-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, specify 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. For more information, see "Managing labels."
# 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: - "*"
|Defines the contents within it as the custom template for your release notes.||Required.||No value accepted.|
|Creates a category of pull requests to be excluded from the release. Can be set at the top-level of the changelog to apply to all categories or applied on a per-category basis.||Optional||No value accepted.|
|Specifies authors to be excluded from the release.||Optional for ||Accepts usernames and bots as values.|
|Defines the nested contents as custom categories to be included in the template.||Optional||No value accepted.|
|Creates an individual category.||Required if ||Takes the category name as its value.|
|Specifies labels to be used by the enclosing category.||Required if ||Accepts any labels, whether currently existing or planned for the future.|
|Catchall for any pull request not included within a category above. If used, it must be added at the end of the file.||Optional||No value accepted.|