search

otsaloma / gaupol

Editor for text-based subtitle files
https://otsaloma.io/gaupol/
GNU General Public License v3.0
247 stars 35 forks source link

Fix deprecated top-level developer_name in AppData XML #214

Closed musicinmybrain closed 8 months ago

musicinmybrain commented 8 months ago

Use the name element in a developer block instead, as recommended by appstreamcli 1.0.0.

This fixes all warnings when validating the AppData XML file, although there are still informational messages:

I: io.otsaloma.gaupol.desktop:67: developer-id-missing
   The `developer` element is missing an `id` property, containing a unique string ID for the
   developer. Consider adding a unique ID.

✔ Validation was successful: infos: 1
otsaloma commented 8 months ago

Hi! Where do you see these deprecations/changes? Is it just appstreamcli output? Because I don't see anything regarding developer-name at https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html or https://github.com/ximion/appstream/blob/main/NEWS. Also, the latest version I see is 0.16.x. Where's your 1.0.0 from? Is it a stable release?

musicinmybrain commented 8 months ago

Right, this is just appstreamcli validate output. The FreeDesktop documentation doesn’t reflect any of this yet, which I find frustrating.

My appstream is a pre-release as currently packaged in Fedora Linux Rawhide (the development version of the OS). It corresponds to https://github.com/ximion/appstream/commit/d88ed03cb5b3b1803bdee3528c9b99d528ceb065. Issue https://github.com/ximion/appstream/issues/244 is related.

I needed to deal with this now for Fedora (in Rawhide only) because appstreamcli validate fails (exits with nonzero status) when there are warnings, which is why I went ahead and wrote a PR. On the other hand, I would certainly understand if you chose not to act on this until after the appstream 1.0.0 final release. In that case, please just consider this PR an advance warning of something you will likely have to deal with in the future.

otsaloma commented 8 months ago

Seems to validate fine with appstreamcli 0.16.2 I have installed, so I guess this is fine. Thanks for noticing and the PR!

musicinmybrain commented 7 months ago

Just as a quick follow-up, version 1.0.0 of appstream was released, and the FreeDesktop documentation was updated.

If you would like to add an id to the developer element, it seems like otsaloma.io could be a reasonable choice.