mirror of
https://github.com/harvard-edge/cs249r_book.git
synced 2026-03-11 17:49:25 -05:00
19277df465
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.
61 lines
1.5 KiB
YAML
61 lines
1.5 KiB
YAML
# =============================================================================
|
|
# 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:
|
|
- "*"
|