From 2e4d26b273fd0b97b518de326c2e92923cabe111 Mon Sep 17 00:00:00 2001
From: Alfredo Gutierrez <alfredo@swirldslabs.com>
Date: Wed, 13 Nov 2024 20:05:56 -0600
Subject: [PATCH] ci: Add a Release Notes template and label categorization for
 easy auto generation. (#335)

Signed-off-by: Alfredo Gutierrez <alfredo@swirldslabs.com>
---
 .github/release.yaml | 79 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 79 insertions(+)
 create mode 100644 .github/release.yaml

diff --git a/.github/release.yaml b/.github/release.yaml
new file mode 100644
index 000000000..974911be4
--- /dev/null
+++ b/.github/release.yaml
@@ -0,0 +1,79 @@
+##
+# Copyright (C) 2024 Hedera Hashgraph, LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+changelog:
+  exclude:
+    labels: ['wontfix', 'question', 'duplicate', 'invalid']
+  categories:
+    - title: '🚀 Enhancements'
+      labels: ['Feature Enhancement', 'New Feature']
+    - title: '🐛 Bug Fixes'
+      labels: ['Bug']
+    - title: '🔨 Tests'
+      labels: ['Tests']
+    - title: '📝 Documentation'
+      labels: ['Documentation', 'Design']
+    - title: '🔒 Security'
+      labels: ['Security']
+    - title: '🔧 Improvements'
+      labels: ['Improvement']
+    - title: '🔥 Breaking Changes'
+      labels: ['Breaking Change']
+    - title: '⬆️ Dependency Upgrades'
+      labels: ['dependencies']
+  sort: 'desc'
+  transformers:
+    - pattern: '^feat: (.*)$'
+      target: 'Feature: $1'
+    - pattern: '^fix: (.*)$'
+      target: 'Fix: $1'
+    - pattern: '^docs: (.*)$'
+      target: 'Docs: $1'
+    - pattern: '^style: (.*)$'
+      target: 'Style: $1'
+    - pattern: '^refactor: (.*)$'
+      target: 'Refactor: $1'
+    - pattern: '^perf: (.*)$'
+      target: 'Performance: $1'
+    - pattern: '^test: (.*)$'
+      target: 'Test: $1'
+    - pattern: '^chore: (.*)$'
+      target: 'Chore: $1'
+    - pattern: '^revert: (.*)$'
+      target: 'Revert: $1'
+    - pattern: '^security: (.*)$'
+      target: 'Security: $1'
+    - pattern: '^build: (.*)$'
+      target: 'Build: $1'
+    - pattern: '^ci: (.*)$'
+      target: 'CI: $1'
+  template: |
+    # $RELEASE_TITLE
+
+    **Release Date:** $RELEASE_DATE
+
+    ## Changes
+
+    $CHANGES
+
+    ## 👥 Contributors
+
+    $CONTRIBUTORS
+
+    ---
+
+    ## 📜 Full Changelog
+
+    [View the full changelog]($COMPARE_URL)