Correct AppStream metainfo XML fixing validations errors. #13309
Conversation
The specification state that the ID and file name should be in reverse DNS form, and that '-' is an invalid character, so the customary way to handle it is replace '-' with '_'. Also, replaced http with https links for screen shots and drop the now obsolete <developer> tag. Adjusted build system to use the new file name.
|
https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-id-generic got some more information on ID generation. |
There was a problem hiding this comment.
Not sure what's going on with the flatpak builders, they fail to get the screenshots for the Flatpak repo. That's the step over here:
https://github.com/dolphin-emu/sadm/blob/9f48ecae866d4b47988b66cbc564652b0bcfc96e/roles/buildbot/etc/master.cfg#L608
| @@ -1,11 +1,8 @@ | |||
| <?xml version="1.0" encoding="UTF-8"?> | |||
| <!-- Copyright 2016 Jeremy Newton --> | |||
| <component type="desktop-application"> | |||
| <id>org.DolphinEmu.dolphin-emu</id> | |||
| <id>org.dolphin_emu.dolphin_emu</id> | |||
There was a problem hiding this comment.
I'm not sure if you can just go and change this without breaking Flatpak (or something on FlatHub). At least I recall some discussions about the ID, and someone saying that there is a lot more things involved than just changing it in here.
But I think @OatmealDome can probably add more to this.
| <developer id="org.dolphin-emu"> | ||
| <name>Dolphin Emulator Project</name> | ||
| </developer> |
There was a problem hiding this comment.
Did you intentionally remove the <developer> tag? According to your own link, it is still an allowed tag in there. (Then again, I didn't see any XSD or DTD, so I don't know if it is potentially just in the wrong location and needs to move to later, or perhaps earlier, in the file.)
|
[BhaaL]
Did you intentionally remove the `<developer>` tag? According to your
own link, it is still an allowed tag in there. (Then again, I didn't
see any XSD or DTD, so I don't know if it is potentially just in the
wrong location and needs to move to later, or perhaps earlier, in the
file.)
Yes. The validator complained about its presense, so I removed it.
This is what I started with:
% appstreamcli validate Flatpak/org.DolphinEmu.dolphin-emu.metainfo.xml.in
E: org.DolphinEmu.dolphin-emu:4: cid-domain-not-lowercase org.DolphinEmu.dolphin-emu
I: org.DolphinEmu.dolphin-emu:4: cid-contains-hyphen org.DolphinEmu.dolphin-emu
I: org.DolphinEmu.dolphin-emu:6: unknown-tag developer
I: org.DolphinEmu.dolphin-emu:18: screenshot-media-url-not-secure
http://dolphin-emu.org/m/user/flatpak/screenshot_1.png
W: org.DolphinEmu.dolphin-emu:18: screenshot-image-not-found
http://dolphin-emu.org/m/user/flatpak/screenshot_1.png - Unexpected status code: 405
I: org.DolphinEmu.dolphin-emu:22: screenshot-media-url-not-secure
http://dolphin-emu.org/m/user/flatpak/screenshot_2.png
W: org.DolphinEmu.dolphin-emu:22: screenshot-image-not-found
http://dolphin-emu.org/m/user/flatpak/screenshot_2.png - Unexpected status code: 405
I: org.DolphinEmu.dolphin-emu:26: screenshot-media-url-not-secure
http://dolphin-emu.org/m/user/flatpak/screenshot_3.png
W: org.DolphinEmu.dolphin-emu:26: screenshot-image-not-found
http://dolphin-emu.org/m/user/flatpak/screenshot_3.png - Unexpected status code: 405
I: org.DolphinEmu.dolphin-emu:30: screenshot-media-url-not-secure
http://dolphin-emu.org/m/user/flatpak/screenshot_4.png
W: org.DolphinEmu.dolphin-emu:30: screenshot-image-not-found
http://dolphin-emu.org/m/user/flatpak/screenshot_4.png - Unexpected status code: 405
W: org.DolphinEmu.dolphin-emu:39: invalid-iso8601-date ${DOLPHIN_WC_BUILD_DATE}
✘ Validation failed: errors: 1, warnings: 5, infos: 6, pedantic: 1
%
--
Happy hacking
Petter Reinholdtsen
|
|
That's weird. https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-developer mentions it explicitly, and so does the example at the end. It's just an Info though, so maybe keep it around anyways? Also, I wonder if it makes sense to add this validation to CI at some point. Or not, as it's a single file that rarely ever changes I guess (besides the fact that it is a template, not the actual file used in the end). |
|
[BhaaL]
That's weird.
https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-developer
mentions it explicitly, and so does the example at the end. It's just
an Info though, so maybe keep it around anyways?
My goal was to get rid of all validator reported issues. If you want to
keep the <developer> tag I am happy to add it, but left to myself I
would listen to the validator.
…--
Happy hacking
Petter Reinholdtsen
|
The specification state that the ID and file name should be in reverse DNS form, and that '-' is an invalid character, so the customary way to handle it is replace '-' with '_'.
Also, replaced http with https links for screen shots and drop the now obsolete tag.
Adjusted build system to use the new file name.