DarkFlippers / DarkFlippers/qUnleashed

Release notes come from commit titles, not CHANGELOG.md

Open
#33 0 comments 0 reactions 1 assignee Claimed by @mishamyte View on GitHub
area/ci-build
Dominant language
C
Stars
104
Forks
8
Avg merge
3h 41m
Merged PRs (30d)
37

Description

`softprops/action-gh-release` runs with `generate_release_notes: true`, so every release page is a list of commit titles. Meanwhile `CHANGELOG.md` is maintained by hand, grouped into "Main changes" and "Other changes", and never reaches users.

- [ ] Extract the section for the tag being built from `CHANGELOG.md`
- [ ] Pass it as the release `body`, keeping `generate_release_notes` off or appended below
- [ ] Decide the failure mode when the changelog has no section for the tag — fail the release, or fall back to generated notes

Related: #27, since a script that already parses the tag is the natural place to resolve which changelog section to read.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.