Skip to content

Commit

Permalink
Create release.yml file for automatic release notes generation
Browse files Browse the repository at this point in the history
Adds a configuration file 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.

See also #138 (comment)
  • Loading branch information
EwoutH committed Aug 30, 2022
1 parent 0b797ee commit 8f14427
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: Breaking changes ⚠️
labels:
- breaking
- title: New features added 🎉
labels:
- feature
- title: Enhancements made 🛠
labels:
- enhancement
- title: Bugs fixed 🐛
labels:
- bug
- title: Documentation improvements 📜
labels:
- docs
- title: Maintenance 🔧
labels:
- ci
- testing
- dependency
- maintenance
- packaging
- title: Other changes
labels:
- "*"

0 comments on commit 8f14427

Please sign in to comment.