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

Improve metainfo file #1221

Merged
merged 2 commits into from Aug 30, 2023
Merged

Improve metainfo file #1221

merged 2 commits into from Aug 30, 2023

Conversation

Alexander-Wilms
Copy link
Contributor

@Alexander-Wilms Alexander-Wilms commented Aug 29, 2023

The URL types have been used according to https://www.freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-url

I've removed the mention of the license from the list of features, since it's usually shown in a separate badge, like in KDE Discover or on [Flathub](https://flathub.org/apps/org.librepcb.LibrePCB):
image

Perhaps the mentioned innovative concepts could be expanded upon.

Copy link
Member

@ubruhin ubruhin left a comment

Choose a reason for hiding this comment

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

Looks great, thanks! Only a small whitespace issue which makes the stylecheck fail.

You can ignore the macOS CI failure, somehow it suddenly stopped working but it's not related to this PR 😭

share/metainfo/org.librepcb.LibrePCB.appdata.xml Outdated Show resolved Hide resolved
@ubruhin
Copy link
Member

ubruhin commented Aug 30, 2023

I just saw there's a validation tool for this file and quickly run it:

$ appstream-util validate ./share/metainfo/org.librepcb.LibrePCB.metainfo.xml 
./share/metainfo/org.librepcb.LibrePCB.metainfo.xml: FAILED:
• tag-invalid           : <url> type invalid [unknown]
Validation of files failed

Any idea what's the exact problem? May it be related to the tool version?

$ appstream-util --version
Version:	0.7.18

@Alexander-Wilms
Copy link
Contributor Author

Alexander-Wilms commented Aug 30, 2023

Yes, I think these new URL types are not supported by older versions of appstream-util.
Cf. https://bugzilla.redhat.com/show_bug.cgi?id=1830923

The Flathub wiki suggests using the flatpak'd version:

$ flatpak install flathub org.freedesktop.appstream-glib
$ flatpak run org.freedesktop.appstream-glib validate share/metainfo/org.librepcb.LibrePCB.metainfo.xml
share/metainfo/org.librepcb.LibrePCB.metainfo.xml: OK
$ flatpak run org.freedesktop.appstream-glib validate-strict share/metainfo/org.librepcb.LibrePCB.metainfo.xml
share/metainfo/org.librepcb.LibrePCB.metainfo.xml: FAILED:
• tag-missing           : <update_contact> is not present
• value-missing         : <!-- Copyright [year] [name] --> is not present
• aspect-ratio-invalid  : <screenshot> aspect ratio not 16:9 [https://github.com/LibrePCB/librepcb-doc/blob/b5488bb1dd8473d33110e744023e3ca14d796db1/about/img/screenshot.png?raw=true]
• aspect-ratio-invalid  : <screenshot> aspect ratio not 16:9 [https://github.com/LibrePCB/librepcb-website/blob/5be4a16236c62ac587ead7d0d535d75d91c27f60/static/img/board_editor.png?raw=true]
• aspect-ratio-invalid  : <screenshot> aspect ratio not 16:9 [https://github.com/LibrePCB/librepcb-website/blob/5be4a16236c62ac587ead7d0d535d75d91c27f60/static/img/control_panel.png?raw=true]
• aspect-ratio-invalid  : <screenshot> aspect ratio not 16:9 [https://github.com/LibrePCB/librepcb-website/blob/5be4a16236c62ac587ead7d0d535d75d91c27f60/static/img/library_manager.png?raw=true]
• aspect-ratio-invalid  : <screenshot> aspect ratio not 16:9 [https://github.com/LibrePCB/librepcb-website/blob/5be4a16236c62ac587ead7d0d535d75d91c27f60/static/img/schematic_editor.png?raw=true]
• translations-required  : <name> has no translations
• translations-required  : <summary> has no translations
• translations-required  : <description> has no translations
Validation of files failed

@ubruhin
Copy link
Member

ubruhin commented Aug 30, 2023

Alright, thanks for confirming!

Just to be sure, is this now ready from your side so it can be merged? Or do you intend to make more changes?

@Alexander-Wilms
Copy link
Contributor Author

This set of changes is ready to be merged.

Perhaps newer screenshots showcasing the 1.0 GUI using a 16:9 aspect ratio could be added in a separate PR.

@ubruhin ubruhin added deployment os-linux Issues affecting Linux labels Aug 30, 2023
@ubruhin ubruhin added this to the 1.0.0 milestone Aug 30, 2023
@ubruhin ubruhin merged commit 9a60950 into LibrePCB:master Aug 30, 2023
6 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deployment os-linux Issues affecting Linux
Development

Successfully merging this pull request may close these issues.

None yet

2 participants