[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-devel
Subject: Re: AppStream Metadata with our releases
From: "Carl Schwan" <carl () carlschwan ! eu>
Date: 2024-03-23 23:09:38
Message-ID: 6cfbe017-80b4-4fab-ab1c-747be167bcc8 () app ! fastmail ! com
[Download RAW message or body]
Sensing from my phone so sorry for the html email
On Sat, Mar 23, 2024, at 9:06 PM, Julius Künzel wrote:
> 22.03.2024 17:22:33 Albert Astals Cid <aacid@kde.org>:
>
> > El divendres, 22 de març de 2024, a les 0:37:00 (CET), Julius Künzel va
> > escriure:
> > > Hi!
> > >
> > > (This mail goes to multiple lists, please reply to kde-devel)
> > >
> > > With Flathub beeing more strict on its AppStream metadata guidlines [1]
> > > there is yet another spotlight on AppStream metadata.
> > >
> > > AppStream metadata are consumed by app stores like Flathub, Snapcraft,
> > > Discover, our scripts to submit apps to the Microsoft Store and last but
> > > not least by apps.kde.org [2].
> > >
> > > For release info in particular the quality guidelines say: "Make sure all
> > > your releases have release notes, even minor ones." [3] As I think this
> > > makes perfectly sense, I like to propose two things that seem straight
> > > forward to me:
> > >
> > > - We should not remove older releases from the AppStream data as already
> > > suggested by Carl in a merge request [4].
> > >
> > > - Also it would be convenient to add noteworthy changes to the metadata
> > > together with the related code change. However at the moment for KDE Gear
> > > the release is usually only added to the metadata a few days before
> > > tagging. Would it be possible to add the next minor release to the release
> > > branch right after the current one has been released and the next major
> > > release to master ones the upcoming version has been branched?
> > >
> > > I belive this makes it easier for developers to contribute to the release
> > > meta info and I hope it hence raises motivation to do so.
> >
> >
> > My pessimistic opinion is that no one is going to add release notes, we've
> > tried multiple ways to do it, even just asking people to add a keyword to the
> > commit log if that commit log was release news worthy and no one did it past
> > the first few weeks/months.
>
> Well, that might happen, but we don't know if we don't try... And as I don't see this causing any extra \
> work and (yet) can't see any downsides, it is even worth it if it helps just a single app or developer, \
> no?
I see that Volker do add release information for Itinerary on every release and I also try to do that for \
neochat, tokodon and a few other apps.
>
> >
> > It seems appstream has finally added the <url/> support (or maybe was there
> > forever?), so my suggestion is that we just add an release+url entry pointing
> > to
> > https://kde.org/announcements/gear/x.y.z/
> >
> > This way we don't have to do the work twice and has the added bonus of already
> > translatable.
> >
>
> This is a nice suggestion too!
> However, I don't think this conflicts with my suggestion as the text in the appstream should usually be \
> just a short summary of the highlights. So let's do both?
+1
[Attachment #3 (text/html)]
<!DOCTYPE html><html><head><title></title><style \
type="text/css">p.MsoNormal,p.MsoNoSpacing{margin:0}</style></head><body><div>Sensing from my phone so \
sorry for the html email</div><div><br></div><div>On Sat, Mar 23, 2024, at 9:06 PM, Julius Künzel \
wrote:<br></div><blockquote type="cite" id="qt" style=""><div>22.03.2024 17:22:33 Albert Astals Cid \
<<a href="mailto:aacid@kde.org">aacid@kde.org</a>>:<br></div><div><br></div><div>> El divendres, \
22 de març de 2024, a les 0:37:00 (CET), Julius Künzel va<br></div><div>> \
escriure:<br></div><div>>> Hi!<br></div><div>>><br></div><div>>> (This mail goes to \
multiple lists, please reply to kde-devel)<br></div><div>>><br></div><div>>> With Flathub \
beeing more strict on its AppStream metadata guidlines [1]<br></div><div>>> there is yet another \
spotlight on AppStream metadata.<br></div><div>>><br></div><div>>> AppStream metadata are \
consumed by app stores like Flathub, Snapcraft,<br></div><div>>> Discover, our scripts to submit \
apps to the Microsoft Store and last but<br></div><div>>> not least by apps.kde.org \
[2].<br></div><div>>><br></div><div>>> For release info in particular the quality guidelines \
say: "Make sure all<br></div><div>>> your releases have release notes, even minor ones." [3] As I \
think this<br></div><div>>> makes perfectly sense, I like to propose two things that seem \
straight<br></div><div>>> forward to me:<br></div><div>>><br></div><div>>> - We should \
not remove older releases from the AppStream data as already<br></div><div>>> suggested by Carl in \
a merge request [4].<br></div><div>>><br></div><div>>> - Also it would be convenient to add \
noteworthy changes to the metadata<br></div><div>>> together with the related code change. However \
at the moment for KDE Gear<br></div><div>>> the release is usually only added to the metadata a few \
days before<br></div><div>>> tagging. Would it be possible to add the next minor release to the \
release<br></div><div>>> branch right after the current one has been released and the next \
major<br></div><div>>> release to master ones the upcoming version has been \
branched?<br></div><div>>><br></div><div>>> I belive this makes it easier for developers to \
contribute to the release<br></div><div>>> meta info and I hope it hence raises motivation to do \
so.<br></div><div>><br></div><div>><br></div><div>> My pessimistic opinion is that no one is \
going to add release notes, we've<br></div><div>> tried multiple ways to do it, even just asking \
people to add a keyword to the<br></div><div>> commit log if that commit log was release news worthy \
and no one did it past<br></div><div>> the first few weeks/months.<br></div><div><br></div><div>Well, \
that might happen, but we don't know if we don't try... And as I don't see this causing any extra work \
and (yet) can't see any downsides, it is even worth it if it helps just a single app or developer, \
no?<br></div></blockquote><div><br></div><div>I see that Volker do add release information for Itinerary \
on every release and I also try to do that for neochat, tokodon and a few other \
apps.<br></div><div><br></div><blockquote type="cite" id="qt" \
style=""><div><br></div><div>><br></div><div>> It seems appstream has finally added the \
<url/> support (or maybe was there<br></div><div>> forever?), so my suggestion is that we just \
add an release+url entry pointing<br></div><div>> to<br></div><div>> <a \
href="https://kde.org/announcements/gear/x.y.z/">https://kde.org/announcements/gear/x.y.z/</a><br></div><div>><br></div><div>> \
This way we don't have to do the work twice and has the added bonus of already<br></div><div>> \
translatable.<br></div><div>><br></div><div><br></div><div>This is a nice suggestion \
too!<br></div><div>However, I don't think this conflicts with my suggestion as the text in the appstream \
should usually be just a short summary of the highlights. So let's do \
both?<br></div></blockquote><div><br></div><div>+1</div></body></html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic