Skip to content

Commit 97178f6

Browse files
authored
Create release.yml file for automatic release notes generation (#1925)
* Create release.yml file for automatic release notes generation 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). * release.yml: Add experimental category for release note generation
1 parent 9dd07a5 commit 97178f6

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/release.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Docs: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
2+
changelog:
3+
exclude:
4+
labels:
5+
- ignore-for-release
6+
categories:
7+
- title: ⚠️ Breaking changes
8+
labels:
9+
- breaking
10+
- title: 🧪 Experimental features
11+
labels:
12+
- experimental
13+
- title: 🎉 New features added
14+
labels:
15+
- feature
16+
- title: 🛠 Enhancements made
17+
labels:
18+
- enhancement
19+
- title: 🐛 Bugs fixed
20+
labels:
21+
- bug
22+
- title: 📜 Documentation improvements
23+
labels:
24+
- docs
25+
- title: 🔧 Maintenance
26+
labels:
27+
- ci
28+
- testing
29+
- dependency
30+
- maintenance
31+
- packaging
32+
- title: Other changes
33+
labels:
34+
- "*"

0 commit comments

Comments
 (0)