You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@burr.apache.org by "andreahlert (via GitHub)" <gi...@apache.org> on 2026/03/30 19:51:09 UTC
[I] ci: automate release notes generation [burr]
andreahlert opened a new issue, #723:
URL: https://github.com/apache/burr/issues/723
Part of #715
### Problem
Release notes are currently written manually by reviewing the git log between tags. This is time-consuming, error-prone (easy to miss PRs), and inconsistent in format.
### Solution
Adopt a changelog fragment approach (similar to Towncrier or git-cliff):
1. Each PR that should appear in release notes includes a changelog fragment file
2. At release time, fragments are assembled into a structured changelog
3. Fragments are categorized by type (feature, bugfix, improvement, breaking change, etc.)
### Options
- **Towncrier**: Python-based, well-established. Uses fragment files in a \`newsfragments/\` directory. Each fragment is named \`{issue_number}.{type}.rst\`.
- **git-cliff**: Rust-based, generates changelogs from conventional commits. No fragment files needed but requires commit message discipline.
- **GitHub release notes**: Built-in, generates from PR titles and labels. Least effort but least control.
### Recommendation
Start with GitHub's built-in release notes generator configured via \`.github/release.yml\`, using our existing label taxonomy (\`kind/*\`) to categorize entries. This is zero-friction for contributors. Move to Towncrier later if more control is needed.
### Acceptance criteria
- [ ] \`.github/release.yml\` configured with label-to-category mapping
- [ ] Release notes generated automatically for each tag
- [ ] Breaking changes highlighted in their own section
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@burr.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] ci: automate release notes generation [burr]
Posted by "Haricharanpanjwani (via GitHub)" <gi...@apache.org>.
Haricharanpanjwani commented on issue #723:
URL: https://github.com/apache/burr/issues/723#issuecomment-4363298527
@andreahlert I can work on this.. Do we need to get an alignment before we can start the implementation?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@burr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] ci: automate release notes generation [burr]
Posted by "andreahlert (via GitHub)" <gi...@apache.org>.
andreahlert commented on issue #723:
URL: https://github.com/apache/burr/issues/723#issuecomment-4363464159
@Haricharanpanjwani yes, just waiting for @skrawcz and @elijahbenizzy's opinion about this.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@burr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] ci: automate release notes generation [burr]
Posted by "andreahlert (via GitHub) via notifications" <no...@burr.apache.org>.
andreahlert commented on issue #723:
URL: https://github.com/apache/burr/issues/723#issuecomment-6590513906
@Haricharanpanjwani sorry this sat so long. I think we can just start with a .github/release.yml grouping by the kind/* labels, easy to revert if we want towncrier later. go ahead unless @skrawcz or @elijahbenizzy object.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@burr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] ci: automate release notes generation [burr]
Posted by "andreahlert (via GitHub)" <gi...@apache.org>.
andreahlert commented on issue #723:
URL: https://github.com/apache/burr/issues/723#issuecomment-4158144067
@skrawcz @elijahbenizzy right now releases use GitHub's auto-generated "What's Changed" list from PR titles. we could configure `.github/release.yml` to group entries by our `kind/*` labels (features, bugfixes, improvements, breaking changes). same zero effort for contributors but the output is categorized. worth setting up or is the flat list fine?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@burr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org