Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Zughy opened this issue Jun 29, 2024 · 4 comments
Open
Labels

Comments

@Zughy
Copy link
Member

Zughy commented Jun 29, 2024

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 Zughy added the Feature label Jun 29, 2024
@fgaz
Copy link

fgaz commented Jun 30, 2024

+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

@rubenwardy
Copy link
Member

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

@rubenwardy
Copy link
Member

rubenwardy commented Jun 30, 2024

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

@fgaz
Copy link

fgaz commented Jun 30, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Now/Next
Development

No branches or pull requests

3 participants