Create release.yml file for automatic release notes generation#1925
Create release.yml file for automatic release notes generation#1925jackiekazil merged 2 commits intomesa:mainfrom
Conversation
Adds a configuration file `.github/release.yml` that lets GitHub automatically draft release notes based on the labels attached to PRs that will be included in that release. These drafted release notes can form a consistent basis for our changelog and manually expanded with context for certain PRs if needed. The currently proposed labels are `breaking`, `feature`, `enhancement`, `bug`, `docs`, `ci`, `testing`, `dependency`, `maintenance` and `packaging`. The last four are grouped in the changelog under _Maintenance 🔧_. See [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes).
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1925 +/- ##
==========================================
+ Coverage 79.14% 79.62% +0.48%
==========================================
Files 15 15
Lines 1098 1124 +26
Branches 236 244 +8
==========================================
+ Hits 869 895 +26
Misses 198 198
Partials 31 31 ☔ View full report in Codecov by Sentry. |
|
If I am understanding correctly, I merge this once the next release is out and then all request will follow the new labeling |
|
Added the experimental category! You can merge it also before, and then add labels to all the PRs since the 2.1.5 release. |
|
@EwoutH and I went over this... going to merge. Will be helpful. |
|
@EwoutH I didn't know about this. Is it 99% algorithmic, or is there a sizeable element of AI in drafting the release? |
|
100% algorithmic. It just takes the PR labels and titles. The highlights section is manually written (of course you can use AI tools there). |
4 participants
Adds a configuration file
.github/release.ymlthat lets GitHub automatically draft release notes based on the labels attached to PRs that will be included in that release. These drafted release notes can form a consistent basis for our changelog and manually expanded with context for certain PRs if needed.The currently proposed labels are
experimental,breaking,feature,enhancement,bug,docs,ci,testing,dependency,maintenanceandpackaging. The last five are grouped in the changelog under Maintenance 🔧.For this to work nicely, it's important that all merged PRs have one of these labels attached to them and that the PR titles are sufficiently descriptive.
See Automatically generated release notes.
You can see an example of how this looks here (the Highlights and Breaking changes sections are written by hand, the rest is automatically generated).
@jackiekazil and @tpike3 please review.