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: + - "*"