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

Appdata #524

Merged
merged 7 commits into from
Jan 30, 2020
Merged

Appdata #524

merged 7 commits into from
Jan 30, 2020

Conversation

ai
Copy link

@ai ai commented Jan 20, 2020

Another backport from Flatpak PR — AppStream metadata.

I also renamed .desktop file to reverse DNS naming (because of the same reasons behind renaming the icon, hope I didn’t forget to change path somewhere as I did it in the previous PR 😓).

Why this metadata should be in upstream?

  • It is Linux FreeDesktop standard
  • Many different platforms use it. For instance, Snap (Flatpak alternative from Canonical) uses it too.
  • It was created as part of an agreement between major Linux vendors (i.e. Red Hat, Canonical, SUSE, Debian, Mandriva, etc.) to create an infrastructure for application installers.
  • I think you may want to control brand-related things like screenshot or description.

Is it correct?

  • I used AppStream spec and Flatpak guidelines. The only part I missed was the “16:9 aspect ratio” for a screenshot. A lot of apps avoid this rule as well.
  • I called flatpak run org.freedesktop.appstream-glib validate validator.

Notes about the content of metadata:

  • I used CC0-1.0 for metadata_license according to very free license recommendations to be able to use description/screenshot in different stores and cases.
  • I used Yubico name in developer_name. Should we rename it to Yubico developers or to your name?
  • I used my email in update_contact as a promise to help you with a file in the future. But we can replace it with another contact.
  • I put only the latest 5.0.1 and 5.0.0 notes to releases. Technically, we can remove releases. But it will be so nice to see changes directly in Linux’s apps store.

</screenshot>
</screenshots>

<releases>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would drop the releases section for now and keep this minimal, since we already maintain the NEWS file.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The releases are valuable info, it's used in Flathub/GNOME Software/KDE Discover/.. to show to the user which version is available/installed on their system.

It's also a requirement for publishing an application on Flathub.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The NEWS file, is mostly read by: contributors, collaborators, developers or someone involved with the code source. The releases tags here targets a general audience (less technical) I would say

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't know that it was a requirement for Flathub. I'm happy to include these again as they were (sorry @ai ... ), and we'll look into later how to sync the content for them for upcoming releases.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't be hard with https://blog.tenstral.net/2020/01/a-big-appstream-status-update.html. There's now a news-to-metainfo command shipped with appstream-util if you want to automate the task.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted releases removal and add fresh 5.0.2 release there 5883176

resources/com.yubico.yubioath.appdata.xml Outdated Show resolved Hide resolved
@dagheyman
Copy link

dagheyman commented Jan 21, 2020

Looks good! See comments for feedback.

@ai
Copy link
Author

ai commented Jan 21, 2020

Looks good! See comments for feedback.

Fixed 😺

resources/com.yubico.yubioath.appdata.xml Outdated Show resolved Hide resolved
resources/com.yubico.yubioath.appdata.xml Show resolved Hide resolved
resources/com.yubico.yubioath.appdata.xml Outdated Show resolved Hide resolved
@dagheyman
Copy link

Very fast! Added a couple more :)


<name>Yubico Authenticator</name>
<summary>Graphical interface for displaying OATH codes with a YubiKey</summary>
<url type="homepage">https://developers.yubico.com/yubioath-desktop/</url>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could use a bugtracker url

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This repository, as well as the URL to open a support ticket ( https://support.yubico.com/support/tickets/new ) is fine to include.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replaced ccad977

@dagheyman
Copy link

Thanks for all the work on this, merging!

@dagheyman dagheyman merged commit d6d3f8f into Yubico:master Jan 30, 2020
@ai ai mentioned this pull request Jan 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants