Set up release notes grouping #249

New issue

Open

opened 2026-10-13 20:12:28 +00:00 by aaperis · 0 comments

aaperis commented

2026-10-13 20:12:28 +00:00

(Migrated from github.com)

Please describe the feature

As an admin, I want to have a clear changelog for every sdad release so that I can understand the changes in a new release without having to dig through every PR title.

Detailed description

Starting with subsequent releases, we want release notes to be:

Grouped by category (Features, Bug Fixes, etc.)
Based on PR labels.
Create the config file that groups PRs by label in auto-generated release notes.
. Add .github/release.yml with similar content:

changelog:
  exclude:
    labels:
      - ignore-for-release
    authors:
      - dependabot
      - dependabot[bot]
  categories:
    - title: 💥 Breaking Changes
      labels: [breaking]
    - title: 🚀 Features
      labels: [feature, feat, enhancement]
    - title: 🐛 Bug Fixes
      labels: [bug, fix, bugfix]
    - title: ⚡ Performance Improvements
      labels: [performance, perf]
    - title: ♻️ Refactoring
      labels: [refactor]
    - title: 📚 Documentation
      labels: [documentation, docs]
    - title: 🧪 Tests
      labels: [test, tests]
    - title: 🏗️ Build & CI
      labels: [build, ci]
    - title: 🧰 Chores & Maintenance
      labels: [chore, dependencies, deps]
    - title: 📝 Other Changes
      labels: ["*"]   # catch-all — unlabeled PRs still appear

- Create github any missing labels as necessary.

## Additional context

GitHub docs: [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes).

## Please describe the feature As an admin, I want to have a clear changelog for every sdad release so that I can understand the changes in a new release without having to dig through every PR title. ## Detailed description Starting with subsequent releases, we want release notes to be: - Grouped by category (Features, Bug Fixes, etc.) - Based on PR labels. - Create the config file that groups PRs by label in auto-generated release notes. . Add `.github/release.yml` with similar content: ```yaml changelog: exclude: labels: - ignore-for-release authors: - dependabot - dependabot[bot] categories: - title: 💥 Breaking Changes labels: [breaking] - title: 🚀 Features labels: [feature, feat, enhancement] - title: 🐛 Bug Fixes labels: [bug, fix, bugfix] - title: ⚡ Performance Improvements labels: [performance, perf] - title: ♻️ Refactoring labels: [refactor] - title: 📚 Documentation labels: [documentation, docs] - title: 🧪 Tests labels: [test, tests] - title: 🏗️ Build & CI labels: [build, ci] - title: 🧰 Chores & Maintenance labels: [chore, dependencies, deps] - title: 📝 Other Changes labels: ["*"] # catch-all — unlabeled PRs still appear - Create github any missing labels as necessary. ## Additional context GitHub docs: [Automatically generated release notes](https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes).