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

Modernize the AppStream metadata #1575

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AsciiWolf
Copy link
Contributor

@AsciiWolf AsciiWolf commented Aug 4, 2024

Changes proposed in this request:

  • Update description.
  • Add missing name and summary tags.
  • Switch to a rDNS app id format that is now required.
  • Various fixes to make the file adhere to modern standards.

/cc @qreeves

@AsciiWolf
Copy link
Contributor Author

https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-id-generic

The ID must follow a reverse-DNS scheme, consisting of {tld}.{vendor}.{product}, for example org.kde.gwenview or com.hugski.colorhug2. Ownership of {vendor}.{tld} in the domain name system guarantees uniqueness of IDs.

To increase the uniqueness and to distinguish between different pieces of a software suite, it is suggested to append the type name to the component-id in these cases.

(Do not worry about the previous sentence about lowercase letters. Even GNOME uses a mix of lowercase and uppercase for app IDs and there are no problems with it.)

@AsciiWolf
Copy link
Contributor Author

@qreeves @Calinou Any chance you could take a look at this? Thanks!

@AsciiWolf
Copy link
Contributor Author

@Calinou Any chance you could also merge this PR? :)

@Calinou
Copy link
Member

Calinou commented Aug 22, 2024

I don't have write access:

image

@AsciiWolf
Copy link
Contributor Author

Oh! I thought that all members of an organization on GitHub (GitLab) should have write access to its repos.

@qreeves
Copy link
Member

qreeves commented Aug 23, 2024

There's only a handful of people with write access to the base repository because it automatically deploys via continuous integration and to prevent people pushing changes without core developer oversight.

I'm currently taking a break from administrative duties and only working on personal tasks unless deemed critical. I'm aware of this ticket, and after taking a look at it I have determined it requires further research and modification by me before being merged. It certainly isn't important enough to be constantly @'ing project moderators.

I am also not happy with the fact that the file contains both static and dynamic information, as the former makes the latter pretty pointless. With the current setup it doesn't even make sense to declare the namespace like that in the Makefile as pretty much nothing else is using that information.

@AsciiWolf
Copy link
Contributor Author

Thanks for the reply!

I'm aware of this ticket, and after taking a look at it I have determined it requires further research and modification by me before being merged.

Could I ask for some details about this modification that is required? Also, if you need any information about AppStream metadata, I can provide them. I am involved in desktop Linux development and its software distribution (including AppStream and related things) for a quite long time.

I am also not happy with the fact that the file contains both static and dynamic information, as the former makes the latter pretty pointless. With the current setup it doesn't even make sense to declare the namespace like that in the Makefile as pretty much nothing else is using that information.

I fully agree. These dynamic information are probably not much useful (especially the app id that should be the same as id in the actual metadata file name) and could be all replaced with static ones. If any downstream packaging project wants to modify them, sed or similar tools can be used for that.

@AsciiWolf
Copy link
Contributor Author

@qreeves Any chance you could answer my questions from the previous comment? Thanks!

@nochinator
Copy link
Contributor

nochinator commented Sep 23, 2024

did you not read his response?

I'm aware of this ticket, and after taking a look at it I have determined it requires further research and modification by me before being merged.
I'm currently taking a break from administrative duties and only working on personal tasks unless deemed critical. I'm aware of this ticket, and after taking a look at it I have determined it requires further research and modification by me before being merged. It certainly isn't important enough to be constantly @'ing project moderators.

They have this on the docket for when they get time to work on this again. It's a free game developed in free time. Life happens and people need to step away.

@AsciiWolf
Copy link
Contributor Author

That's exactly why I asked if they could answer my questions regarding the "required further research and modification". I could provide help.

By the way, I maintain the Xonotic Flatpak on Flathub.

@qreeves
Copy link
Member

qreeves commented Sep 24, 2024

That's exactly why I asked if they could answer my questions regarding the "required further research and modification". I could provide help.

It means I need to understand the subject better. I can't answer any questions until I do. Please stop @'ing me.

@AsciiWolf
Copy link
Contributor Author

Fair enough. Thanks for the clear answer!

@AsciiWolf
Copy link
Contributor Author

AsciiWolf commented Nov 12, 2024

Since this is taking too long, I propose an alternative that is not ideal, but at least will make the AppStream metadata file valid and accepted by modern parsers:

  • Do not rename the appdata file or change the app id; do not edit Makefile or system-install.mk.
  • Change the component type tag type to desktop-application (desktop should still work, but is deprecated).
  • Add a <launchable type="desktop-id">@[email protected]</launchable> tag
  • Add the name, developer_name and summary tags from this PR.
  • Optionally also add the provides tag, new url tags and remove empty (none) content_attributes from OARS.

- Update description
- Add missing name and summary tags
- Switch to a rDNS app id format that is now required
- Various fixes to make the file adhere to modern standards
@AsciiWolf
Copy link
Contributor Author

I have made a more simpler, smaller alternative to this PR here: #1599

It does not change the app id or AppStream file name and should be ready to be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

4 participants