From 4a6721815fa52e0a79a0676f6d550857862af12c Mon Sep 17 00:00:00 2001
From: Jamie Danielson <jamieedanielson@gmail.com>
Date: Tue, 15 Aug 2023 13:08:17 -0400
Subject: [PATCH] maint: add release.yml for auto-generated release notes (#62)

## Which problem is this PR solving?

- auto-generated release notes are created without categories; a
`release.yml` can be added to specify categorization based on labels
(see [docs
here](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes)
and usage in other repos).

## Short description of the changes

- add `release.yml` with categorization based on other repos like
[honeycomb-opentelemetry-go](https://github.com/honeycombio/honeycomb-opentelemetry-go/blob/main/.github/release.yml)
- also add `type: dependencies` label for maintenance category to avoid
it being always dumped in Other Changes

## How to verify that this has the expected result

next time we click auto-generate release notes we should see the changes
in the appropriate categories based on label (or omitted entirely if set
to `no-changelog`
---
 .github/release.yml | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 .github/release.yml

diff --git a/.github/release.yml b/.github/release.yml
new file mode 100644
index 0000000..0847c1a
--- /dev/null
+++ b/.github/release.yml
@@ -0,0 +1,24 @@
+# .github/release.yml
+
+changelog:
+  exclude:
+    labels:
+      - no-changelog
+  categories:
+    - title: 💥 Breaking Changes 💥
+      labels:
+        - "version: bump major"
+        - breaking-change
+    - title: 💡 Enhancements
+      labels:
+        - "type: enhancement"
+    - title: 🐛 Fixes
+      labels:
+        - "type: bug"
+    - title: 🛠 Maintenance
+      labels:
+        - "type: maintenance"
+        - "type: dependencies"
+    - title: 🤷 Other Changes
+      labels:
+        - "*"
\ No newline at end of file