contentdb icon indicating copy to clipboard operation
contentdb copied to clipboard

Automatically retrieve release notes if "Release Notes" field is left empty

Open Zughy opened this issue 1 year ago • 4 comments

Problem

Release notes are a great addition, but right now I have to write them twice (on GitLab first and then on CDB)

Solutions

Title. It'd be handy if CDB could automatically retrieve the release notes, as it already does with other fields

Alternatives

don't (?)

Zughy avatar Jun 29 '24 13:06 Zughy

+1! Specifically I'd like if release notes were extracted from git tag annotations (example), which is a forge-agnostic way to attach a description to a tag. This way, there is no need to add support for gitlab releases, forgejo releases, github releases etc

fgaz avatar Jun 30 '24 07:06 fgaz

I don't think GitHub releases edit the tag annotations right? So there's not a universal solution

rubenwardy avatar Jun 30 '24 16:06 rubenwardy

Not deployed yet, but:

Git Update Detection now uses the annotated tag for release notes. I'll try and find the tag when making releases using other methods (IE: API or web interface). I'll look into what GitHub/GitLab does with releases

This may be controversial but it also uses the commit log if no other release notes could be found. I'll monitor this and disable if it turns out pretty useless

rubenwardy avatar Jun 30 '24 16:06 rubenwardy

I don't think GitHub releases edit the tag annotations right? So there's not a universal solution

I think the opposite (since the tag comes first) is doable. With the help of github actions if not natively

fgaz avatar Jun 30 '24 17:06 fgaz