Skip to content

Commit

Permalink
Create release.yml file for automatic release notes generation (#95)
Browse files Browse the repository at this point in the history
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 `experimental`, `breaking`, `feature`, `enhancement`, `bug`, `docs`, `ci`, `testing`, `dependency`, `maintenance` and `packaging`. The last five 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).

Co-authored-by: Adam Amer <136176500+adamamer20@users.noreply.github.com>
  • Loading branch information
EwoutH and adamamer20 authored Sep 2, 2024
1 parent 73a5024 commit 75fc38d
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Docs: https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: ⚠️ Breaking changes
labels:
- breaking
- title: πŸ§ͺ Experimental features
labels:
- experimental
- 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 75fc38d

Please sign in to comment.