Skip to content

appstream: Add metainfo to all packages containing a .desktop file #1389

@joebonrichie

Description

@joebonrichie

As we plan to ship GNOME Software / Discover to replace solus-sc, it's important that all graphical packages contain appstream metainfo. This is due to the fact that G-S/Discover only show packages with appstream data. For better discoverability all graphical packages should provide this.

A package should provide appstream metainfo if it contains a .desktop file. e.g. /usr/share/applications/foo.desktop

Valid paths for appstream metainfo are:
/usr/share/metainfo/org.some.package.xml
/usr/share/appdata/org.some.package.xml <- legacy, discouraged.

Since appstream builder can't handle symlinks, the package.yml file should use install for the metadata file rather than a symlink

We have a separate issue for tracking truetype/opentype font packages without appstream metainfo.xml files here: #449

Scenarios

Scenario 1: An application already provides appstream metainfo.
Solution: Nothing to do.

Scenario 2: An application contains appstream metainfo in the source package but we do not install it.
Solution: Install the appstream metainfo to /usr/share/metainfo
Example: 0a726a5

Scenario 3: An application doesn't contain appstream metainfo in the source package but it exists on flathub.
Solution: Borrow and tweak the appstream metainfo from the flathub repo. Encourage upstream to add it to their source.
Example: da2f65b

Scenario 4: An application doesn't provide appstream metainfo and it doesn't exist on flathub
Solution: Write the appstream data, submit it to upstream.Appstream data can be created using this webapp. Use CC0-1.0 (Creative Commons Zero v1.0 Universal) as the metadata license
Example: 414219d

Scenario 5: Appstream metainfo is provided but generation of it is failing
Solution: See https://github.com/getsolus/solus-appstream-data#debugging-failures
Example: 583b7c7

Testing appstream data

See https://github.com/getsolus/solus-appstream-data#testing-individual-packages

Note that after adding appstream data to a package it will not show up in solus-sc/G-S/Discover until we refresh appstream data for the entire repo (normally every couple of weeks).

Other Info

Generally speaking, a package must provide one appstream metainfo file, an icon as well as an .desktop file to succeed. However, there are exceptions to this. If an application provides more than one appstream metainfo file then the package must be subpackaged to generation of all the appstream metainfo files to succeed.

The List

  • 121 packages left
  • The list of packages can viewed on our "proof-of-concept" dashboard
  • Or using go-task check-appstream-progress in your local clone of Solus packages repository

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: ChoreNot a feature or a bug

    Type

    No type

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions