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

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

Open
joebonrichie opened this issue Jan 21, 2024 · 1 comment
Open
Labels
Type: Chore Not a feature or a bug

Comments

@joebonrichie
Copy link
Contributor

joebonrichie commented Jan 21, 2024

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

  • 316 229 216 217 211 204 199 packages left
  • The list of packages can viewed on our PoC dashboard
  • Or using go-task check-appstream-progress in your local clone of Solus packages repository
@github-project-automation github-project-automation bot moved this to Triage in Solus Jan 21, 2024
@joebonrichie joebonrichie pinned this issue Jan 21, 2024
@davidjharder davidjharder added the Type: Chore Not a feature or a bug label Jan 22, 2024
@davidjharder davidjharder moved this from Triage to Ready in Solus Jan 22, 2024
malfisya added a commit to malfisya/packages that referenced this issue Jan 22, 2024
**Summary**

- Install appdata.xml
- Move icon install directory to hicolor
- Part of getsolus#1389

**Test Plan**

- Rebuild package
- Verify metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 22, 2024
**Summary**

- Install appdata.xml
- Move icon install directory to hicolor
- Part of getsolus#1389

**Test Plan**

- Rebuild package
- Verify metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 22, 2024
**Summary**

- Added appstream metadata (Part of getsolus#1389)
- Move icon file to hicolor

**Test Plan**

- Build the package
- Verify with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 22, 2024
**Summary**

- Install appstream metadata (Part of getsolus#1389)
- Move icon install directory to hicolor

**Test Plan**

- Rebuild package
- Verify metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
joebonrichie added a commit that referenced this issue Jan 22, 2024
**Summary**

- Install appdata.xml
- Move icon install directory to hicolor
- Part of #1389

**Test Plan**

- Rebuild package
- Verify metadata with `appstream-builder --packages-dir=.
--include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 23, 2024
**Summary**

- Added homepage (Part of getsolus#411)
- Added appstream metadata ( Part of getsolus#1389)
- Replaced old and ugly icon

*Test Plan**

- Verified homepage loads informaton about packages
- Verifed metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
EbonJaeger added a commit that referenced this issue Jan 23, 2024
**Summary**
- Split plugins into subpackages

Ref #1389
Fixes #4

Signed-off-by: Evan Maddock <[email protected]>
EbonJaeger added a commit that referenced this issue Jan 23, 2024
**Summary**
- Split plugins into subpackages

Ref #1389
Fixes #4

Signed-off-by: Evan Maddock <[email protected]>
EbonJaeger added a commit that referenced this issue Jan 23, 2024
**Summary**
- Split plugins into subpackages

Ref #1389
Fixes #4

Signed-off-by: Evan Maddock <[email protected]>

**Test Plan**

Install the updated gedit-plugins package, see that the split packages
were all installed, verify that the plugins appeared in the Plugins page
of the gedit settings.

**Checklist**

- [x] Package was built and tested against unstable
@malfisya
Copy link
Member

I will start from games component, that's where GUI at.

malfisya added a commit to malfisya/packages that referenced this issue Jan 23, 2024
**Summary**

- Added homepage (Part of getsolus#411)
- Added appstream metadata ( Part of getsolus#1389)
- Replaced old and ugly icon

*Test Plan**

- Verified homepage loads informaton about packages
- Verifed metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 23, 2024
**Summary**

- Added homepage (Part of getsolus#411)
- Added appstream metadata ( Part of getsolus#1389)
- Replaced old and ugly icon

**Test Plan**

- Verified homepage loads informaton about packages
- Verifed metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
EbonJaeger added a commit that referenced this issue Jan 24, 2024
**Summary**

- Added homepage (Part of
#411)
- Added appstream metadata ( Part of
#1389)
- Replaced old and ugly icon

**Test Plan**

- Verified homepage loads informaton about packages
- Verifed metadata with `appstream-builder --packages-dir=.
--include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 24, 2024
**Summary**

- Install upstream appstream metadata (Part of getsolus#1389)
- Install upstream desktop file with StartupWMClass fixed
- Replaced homepage with a more representative one

**Test Plan**

- Verified metadata with `appsappstream-builder --packages-dir=. --include-failed -v`
- Verified homepage loads relevant informations
- Make sure app icon in panel and overview are displayed correctly (tested on GNOME, Plasma, Budgie)

**Checklist**

- [x] Package was built and tested against unstable
EbonJaeger added a commit that referenced this issue Jan 24, 2024
**Summary**

- Install upstream appstream metadata (Part of
#1389)
- Install upstream desktop file with StartupWMClass fixed
- Replaced homepage with a more representative one

**Test Plan**

- Verified metadata with `appsappstream-builder --packages-dir=.
--include-failed -v`
- Verified homepage loads relevant informations
- Make sure app icon in panel and overview are displayed correctly
(tested on GNOME, Plasma, Budgie)

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 25, 2024
**Summary**

- Install appstream metadata (Part of getsolus#1389)
- Added homepage key (Part of getsolus#411)
- Use patched upstream desktop file
- Use patched upstream Makefile

**Test Plan**

- Verify metadata with `appstream-builder --packages-dir=. --include-failed -v`
- Verify homepage loads relevant information
- Make sure app icon switch properly depending on icon theme (Tested on GNOME, Budgie, Plasma)
- Install `foobar2000` on Budgie VM

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit to malfisya/packages that referenced this issue Jan 25, 2024
**Summary**

Install appstream metadata (Part of getsolus#1389)

**Test Plan**

Verify metadata with `appstream-builder --packages-dir=. --include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
joebonrichie added a commit that referenced this issue Jan 25, 2024
**Summary**

Install appstream metadata (Part of #1389)

**Test Plan**

Verify metadata with `appstream-builder --packages-dir=.
--include-failed -v`

**Checklist**

- [x] Package was built and tested against unstable
joebonrichie added a commit that referenced this issue Jan 25, 2024
**Summary**

- Install appstream metadata (Part of
#1389)
- Added homepage key (Part of
#411)
- Use patched upstream desktop file
- Use patched upstream Makefile

**Test Plan**

- Verify metadata with `appstream-builder --packages-dir=.
--include-failed -v`
- Verify homepage loads relevant information
- Make sure app icon switch properly depending on icon theme (Tested on
GNOME, Budgie, Plasma)
- Install `foobar2000` on Budgie VM

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit that referenced this issue Jun 18, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Jun 20, 2024
**Summary**

- Add app icon
- Add appstream metainfo (Part of #1389)
EbonJaeger added a commit that referenced this issue Jun 20, 2024
**Summary**

- Add app icon
- Add appstream metainfo (Part of #1389)

**Test Plan**

<!-- Short description of how the package was tested -->
Install and run the app

**Checklist**

- [x] Package was built and tested against unstable
@malfisya malfisya mentioned this issue Jun 25, 2024
1 task
malfisya added a commit that referenced this issue Jul 1, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Resolved #3083
malfisya added a commit that referenced this issue Jul 1, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Jul 1, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Jul 1, 2024
**Summary**

- Fix build failure (Resolves #2564)
- Patch courtesy of @HarveyDevel
- Add `homepage` key to `package.yml` (Part of #411)
- Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Jul 1, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Resolved #3083
joebonrichie added a commit that referenced this issue Jul 5, 2024
**Summary**

- Fix build failure (Resolves #2564)
- Patch courtesy of @HarveyDevel
- Add `homepage` key to `package.yml` (Part of #411)
- Add appstream metainfo (Part of #1389)

**Test Plan**

<!-- Short description of how the package was tested -->
Launch IDE

**Checklist**

- [x] Package was built and tested against unstable
joebonrichie added a commit that referenced this issue Jul 5, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Resolved #3083

**Test Plan**

<!-- Short description of how the package was tested -->
Verify metainfo with appstream-builder --packages-dir=. --include-failed
-v

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit that referenced this issue Jul 14, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Jul 14, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Use cargo macros (Part of #3111)
@malfisya malfisya mentioned this issue Jul 14, 2024
1 task
algent-al added a commit that referenced this issue Jul 14, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Use cargo macros (Part of #3111)

**Test Plan**

<!-- Short description of how the package was tested -->
Verify metainfo with appstream-builder --packages-dir=. --include-failed
-v

**Checklist**

- [x] Package was built and tested against unstable
malfisya added a commit that referenced this issue Jul 16, 2024
**Summary**

- add metainfo
-  part of #1389

- [x] Package was built and tested against unstable
malfisya added a commit that referenced this issue Jul 16, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Jul 16, 2024
**Summary**

- Remove redundant steps in package.yml
- Add appstream metainfo (Part of #1389)
- Add MAINTAINERS.md
malfisya added a commit that referenced this issue Jul 16, 2024
**Summary**

- Remove redundant steps in package.yml
- Add appstream metainfo (Part of #1389)
- Add MAINTAINERS.md
malfisya added a commit that referenced this issue Jul 18, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Aug 8, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Add monitoring.yml
malfisya added a commit that referenced this issue Aug 9, 2024
**Summary**

- Add appstream metainfo (Part of #1389)
- Add monitoring.yml
malfisya added a commit that referenced this issue Nov 13, 2024
**Summary**

Add appstream metainfo (Part of #1389)
malfisya added a commit that referenced this issue Nov 13, 2024
**Summary**

Add appstream metainfo (Part of #1389)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Chore Not a feature or a bug
Projects
Status: Ready
Development

No branches or pull requests

3 participants