|
| 1 | +# .github/release.yml |
| 2 | +# |
| 3 | +# Controls the auto-generated release notes produced by GitHub when |
| 4 | +# `generate_release_notes: true` is set in the release creation step. |
| 5 | +# |
| 6 | +# Categories are evaluated in order — the first matching label wins. |
| 7 | +# PRs with no matching label fall into the catch-all at the bottom. |
| 8 | +# |
| 9 | +# Label-to-prefix mapping (applied by the PR title validation workflow): |
| 10 | +# fix: -> Bug |
| 11 | +# feat: -> Enhancement |
| 12 | +# improve: -> Improvement |
| 13 | +# ci: -> CI |
| 14 | +# docs: -> Documentation |
| 15 | +# style: -> Style |
| 16 | +# build: -> Build |
| 17 | +# refactor: -> Refactor |
| 18 | +# test: -> Test |
| 19 | +# chore: -> Chore |
| 20 | +# Dependabot -> Dependencies (applied automatically by GitHub) |
| 21 | +# |
| 22 | +# Note: GitHub matches on PR labels, not on the title prefix directly. |
| 23 | +# The labels above must be created in the repository and applied to PRs |
| 24 | +# — either manually or via a labeler workflow — for categorization to work. |
| 25 | +# Until a labeler is in place, all PRs will appear under "Other Changes". |
| 26 | + |
| 27 | +--- |
| 28 | +changelog: |
| 29 | + exclude: |
| 30 | + # Exclude the automated version-bump PRs opened by the versioning workflow. |
| 31 | + labels: |
| 32 | + - skip-changelog |
| 33 | + |
| 34 | + categories: |
| 35 | + # ----------------------------------------------------------------- |
| 36 | + # User-facing: fixes first — most actionable for users on older versions |
| 37 | + # ----------------------------------------------------------------- |
| 38 | + - title: "Bug Fixes" |
| 39 | + labels: |
| 40 | + - Bug |
| 41 | + |
| 42 | + # ----------------------------------------------------------------- |
| 43 | + # User-facing: new capabilities |
| 44 | + # ----------------------------------------------------------------- |
| 45 | + - title: "New Features" |
| 46 | + labels: |
| 47 | + - Enhancement |
| 48 | + |
| 49 | + # ----------------------------------------------------------------- |
| 50 | + # User-facing: improvements to existing behavior |
| 51 | + # ----------------------------------------------------------------- |
| 52 | + - title: "Improvements" |
| 53 | + labels: |
| 54 | + - Improvement |
| 55 | + |
| 56 | + # ----------------------------------------------------------------- |
| 57 | + # User-facing: documentation changes |
| 58 | + # ----------------------------------------------------------------- |
| 59 | + - title: "Documentation" |
| 60 | + labels: |
| 61 | + - Documentation |
| 62 | + |
| 63 | + # ----------------------------------------------------------------- |
| 64 | + # Internal: still visible, but lower priority for end users |
| 65 | + # ----------------------------------------------------------------- |
| 66 | + - title: "CI & Automation" |
| 67 | + labels: |
| 68 | + - ci |
| 69 | + |
| 70 | + - title: "Style & Formatting" |
| 71 | + labels: |
| 72 | + - Style |
| 73 | + |
| 74 | + - title: "Build System" |
| 75 | + labels: |
| 76 | + - Build |
| 77 | + |
| 78 | + - title: "Refactoring" |
| 79 | + labels: |
| 80 | + - Refactor |
| 81 | + |
| 82 | + - title: "Tests" |
| 83 | + labels: |
| 84 | + - Test |
| 85 | + |
| 86 | + - title: "Chores" |
| 87 | + labels: |
| 88 | + - Chore |
| 89 | + |
| 90 | + # ----------------------------------------------------------------- |
| 91 | + # Dependabot last — visible but not noise for users reading top-down |
| 92 | + # ----------------------------------------------------------------- |
| 93 | + - title: "Dependency Updates" |
| 94 | + labels: |
| 95 | + - dependencies |
| 96 | + |
| 97 | + # ----------------------------------------------------------------- |
| 98 | + # Catch-all: unlabelled PRs still appear rather than being silently dropped |
| 99 | + # ----------------------------------------------------------------- |
| 100 | + - title: "Other Changes" |
| 101 | + labels: |
| 102 | + - "*" |
| 103 | +... |
0 commit comments