From 19277df465b589fe6ed4fde84808d85367dd8d42 Mon Sep 17 00:00:00 2001 From: Vijay Janapa Reddi Date: Thu, 22 Jan 2026 16:45:27 -0500 Subject: [PATCH] chore: add release.yml for auto-generated release notes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Configures GitHub to automatically categorize PRs by labels when generating release notes. Categories include: - ๐Ÿš€ New Features (feature, enhancement, feat) - ๐Ÿ› Bug Fixes (bug, fix) - ๐Ÿ“š Documentation (docs, area: book) - ๐Ÿงช Tests - ๐Ÿ”ง CI/Infrastructure - ๐Ÿ”ฅ TinyTorch (area: tinytorch) - ๐ŸŒ Website (area: website) - ๐Ÿ› ๏ธ Other Changes Excludes skip-changelog, dependencies, and chore labels. --- .github/release.yml | 60 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..75304da0c --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,60 @@ +# ============================================================================= +# GitHub Auto-Generated Release Notes Configuration +# ============================================================================= +# This file configures how GitHub automatically generates release notes. +# When creating a release, GitHub will categorize PRs based on labels. +# +# Usage: When creating a release via UI or CLI with --generate-notes flag, +# GitHub will use these categories to organize the changelog. +# ============================================================================= + +changelog: + # Exclude certain labels from release notes + exclude: + labels: + - "skip-changelog" + - "dependencies" + - "chore" + + # Categorize PRs by labels + categories: + - title: "๐Ÿš€ New Features" + labels: + - "type: feature" + - "enhancement" + - "feat" + + - title: "๐Ÿ› Bug Fixes" + labels: + - "type: bug" + - "bug" + - "fix" + + - title: "๐Ÿ“š Documentation" + labels: + - "documentation" + - "docs" + - "area: book" + + - title: "๐Ÿงช Tests" + labels: + - "tests" + - "testing" + + - title: "๐Ÿ”ง CI/Infrastructure" + labels: + - "ci" + - "infrastructure" + - "area: tools" + + - title: "๐Ÿ”ฅ TinyTorch" + labels: + - "area: tinytorch" + + - title: "๐ŸŒ Website" + labels: + - "area: website" + + - title: "๐Ÿ› ๏ธ Other Changes" + labels: + - "*"