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

Add <url> and <releases> to the metainfo #1592

Closed
wants to merge 1 commit into from
Closed

Add <url> and <releases> to the metainfo #1592

wants to merge 1 commit into from

Conversation

acperkins
Copy link

Flathub requires <url> and <releases> tags in the AppData file.

https://www.freedesktop.org/software/appstream/docs/sect-Metadata-Releases.html

The <releases> tag can be much more detailed and include descriptions, issues, artifacts, and much more. For now I've only included the minimum required: version and date.

I've included dates of all of the previous versions that were listed on Github, as the information was available, but it would be sufficient to only include the latest release for now.

@CendioOssman
Copy link
Member

Thank you for your additions.

We explicitly left <releases> out of the document, as we didn't want another thing to keep updated. :/

I couldn't find any reference to this being required by Flathub in their wiki. Do you have a reference for this?

@acperkins
Copy link
Author

I couldn't find any reference to this being required by Flathub in their wiki. Do you have a reference for this?

The documentation is minimal but mentions that the appdata file must pass the validator. The requirements for <url> and <releases> are highlighted when you run that against the metainfo file:

$ flatpak run org.freedesktop.appstream-glib validate org.tigervnc.vncviewer.metainfo.xml.in
org.tigervnc.vncviewer.metainfo.xml.in: FAILED:
• tag-missing           : <release> required
• tag-missing           : <url> is not present
Validation of files failed
$

@CendioOssman
Copy link
Member

Hmm... So it's a flatpak thing, not a flathub one. I dug around a bit more, and I found the spec suggests adding <releases>:

https://www.freedesktop.org/software/appstream/docs/chap-Quickstart.html#qsr-app-contents-suggestions

That section also states that <provides> should be included, which the tool doesn't seem to complain about...

@CendioOssman
Copy link
Member

This seems to be a mess where Flathub doesn't document their requirements, and appstream-util tries to arbitrary follow. And no one seems to care about the specification:

hughsie/appstream-glib#457

The metainfo passes on validate-relax though, which is the check level recommended by flatpak. Could you poke Flathub back and see why they require stricter checks than that?

@acperkins
Copy link
Author

I don't know anyone at Flathub that I could poke, I was just following the submission guidelines.

I've patched the required tags as part of the Flathub build instead and that's worked.

@acperkins acperkins closed this Feb 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants