Add freedesktop compliant appstream & metainfo #11227

Doomsdayrs · 2023-05-26T20:33:34Z

Validated to match requirements set by freedesktop via desktop-file-check and flatpak run org.freedesktop.appstream-glib validate rs.ruffle.Ruffle.metainfo.xml.

Related: #9220

Doomsdayrs · 2023-05-30T01:20:06Z

~~Note, If the metainfo file is accepted upstream, it is expected to be automatically updated by upstream as well with each release of Ruffle (or pre-release with the current model).~~

Dinnerbone

LGTM

danielhjacobs · 2023-06-14T15:13:28Z

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml

+ <url type="vcs-browser">https://github.com/ruffle-rs/ruffle</url>
+ <url type="contribute">https://github.com/ruffle-rs/ruffle/blob/master/CONTRIBUTING.md</url>
+ <releases>
+ <release version="nightly-2023-05-26" date="2022-05-26"/>


To be clear, is this version string supposed to be updated with every nightly release? If so, it may be a good idea to somehow add doing so to CI before this gets merged.

This file should be updated with each release of Ruffle with a basic version and date tags.

But I apologize, I am not familiar with github workflows enough to understand how it can be done.

The basic idea would be to hook onto release-nightly that commits the repo with the updated metainfo before doing the release process.

I'm somewhat against jamming a commit into master every single day just for this.
Could this be omitted here?
Perhaps maintained in a separate branch?

Standard practice would be updating this file with a changelog. That way users can see in GUI why there is an update and what changes justifying the update. Currently nightlies do not include a changelog, although it would be nice to have one generated so both the metainfo and the github release would have the nightly.

I understand concerns in regards to having this in the main repository. And yes it could be handled in a separate upstream repository, a "ruffle-meta" repository perchance. But then how is versioning handled, syncing the meta repository releases with the main repositories releases?

I also would like to hear feedback from @relrelb who worked on the AUR package who also requires the metainfo.

As for the changelog, at least GitHub generates one for the nightly releases: https://github.com/ruffle-rs/ruffle/releases

While the expected treatment is to update metainfo with each release. I suppose that is a bit too much for the nightly format.

We can skip over having to update the metainfo until Ruffle stable releases are created.

@relrelb Does that sound good for you?

Another option could be to generate this based on the tag at build time by for example having some easily replaceable pattern.

I don't believe every nightly version should be added here, it's not intended for testing or development.

Only stable (a relative term) versions that need to be published should be added.

I wish ruffle-rs had some kind of versions, even if it was alpha for example instead of just nightly builds.

We've long planned to come up with something like that, but there's just no clear point of "when" a release should be cut. Every nightly is basically like the next - with a few exceptions one way or another.

That's why the browser extensions and the Android app are "randomly" published: weekly, or every few days/weeks, basically at random.

The same thing could work here, don't you think?

I think as long as this hardcoded version here is replaced with some sort of @PLACEHOLDER@, to be substituted just before publishing, this should be fine.

torokati44 · 2023-12-13T16:23:45Z

So, do you think the <release version="nightly-2023-05-26" date="2022-05-26"/> issue could be automated away somehow, so that it's not hardcoded in the repo, and doesn't need to be updated - rather, filled out as part of the flatpak build process?
Perhaps https://github.com/ruffle-rs/ruffle/blob/master/web/packages/core/tools/set_version.js can give some inspiration - it could even be used as is, and then copying the version over from the .json to the .xml somehow?

torokati44 · 2023-12-13T16:24:33Z

Also, by this time, our menu has gained some new items, and the launcher is an "advanced open dialog" now, so could you please update the screenshots? Sorry for dragging this out for so long...

torokati44 · 2023-12-13T16:42:18Z

filled out as part of the flatpak build process

See for example how the AUR package does it: https://github.com/ruffle-rs/ruffle/blob/master/.github/workflows/release_nightly.yml#L516-L531

I think a similar solution (in the "recipe" to build it) would be fine here as well, as part of: flathub/flathub#4179

Doomsdayrs · 2024-02-14T00:23:30Z

Also, by this time, our menu has gained some new items, and the launcher is an "advanced open dialog" now, so could you please update the screenshots? Sorry for dragging this out for so long...

Done!

jh-devv · 2024-02-23T13:32:26Z

I saw a Mastodon post about this, does the GitHub actions thing still need help? I would be open to help!

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml

zefr0x · 2024-02-23T13:51:28Z

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml

+ <control>gamepad</control>
+ </supports>
+ <project_license>MIT OR Apache-2.0</project_license> 
+ <developer_name>ruffle-rs</developer_name>


Suggested change

<developer_name>ruffle-rs</developer_name>

<developer id="rs.ruffle">

<name translatable="no">ruffle-rs</name>

</developer>

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

The standard says to use a URL, where does it say to use reverse-URL?

If it was a person for example in github it should be io.github.x, but if it was the organization shouldn't it be like io.github?

Any way it Ok to use a normal URL as long as it is always unique. The standard is not specific about this.

Any way the method used should be unified for developers under the ruffle-rs name.

desktop/packages/linux/rs.ruffle.Ruffle.desktop

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml

zefr0x · 2024-02-23T14:05:30Z

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml

+ <screenshot type="default">
+ <image>https://raw.githubusercontent.com/ruffle-rs/ruffle/master/desktop/packages/linux/launcher.png</image>
+ </screenshot>
+ <screenshot>
+ <image>https://raw.githubusercontent.com/ruffle-rs/ruffle/master/desktop/packages/linux/btd.png</image>
+ </screenshot>
+ <screenshot>
+ <image>https://raw.githubusercontent.com/ruffle-rs/ruffle/master/desktop/packages/linux/ltf.png</image>
+ </screenshot>


Those URLs should point to something more stable like a commit.

Doomsdayrs · 2024-02-23T14:35:03Z

I saw a Mastodon post about this, does the GitHub actions thing still need help? I would be open to help!

Yes!

jh-devv · 2024-02-26T10:09:05Z

I saw a Mastodon post about this, does the GitHub actions thing still need help? I would be open to help!

Yes!

Good, I'll look into that when I have time! 🥳

kjarosh · 2024-07-22T23:36:48Z

Refreshed this PR a bit, most notable changes:

updated screenshots (ensured that window shadow and rounded corners are included as per the guidelines),
updated URLs (to conform to appstream spec),
updated the update_contact to our official email address and made the developer name more human-friendly,
removed list of releases (we will have to figure this out in the future — either update them automatically each stable release or fill them when building the flatpak).

To do:

add light theme screenshots after desktop: Detect light theme on Linux #17179 (as per the quality guidelines),
update screenshots after desktop: Add View menu #17042,
update the description — currently a lot of it mentions the web version (which the desktop application has little to do with).

desktop/packages/linux/rs.ruffle.Ruffle.desktop

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml

torokati44

I see my version-number-related complaints no longer apply (as there aren't any <releases>), and all my other notes are just nits that can be ignored at will. Thank you to all whomst hath contributed!

desktop/packages/linux/rs.ruffle.Ruffle.desktop

kjarosh · 2024-08-03T16:00:18Z

Thank you to all the contributors!

This was referenced May 26, 2023

Add rs.ruffle.Ruffle flathub/flathub#4179

Closed

Flatpak Support #9220

Closed

Dinnerbone approved these changes Jun 2, 2023

View reviewed changes

danielhjacobs reviewed Jun 14, 2023

View reviewed changes

Doomsdayrs force-pushed the freedesktop-compliance branch from 6e2b88d to 94e0192 Compare July 2, 2023 02:05

torokati44 force-pushed the freedesktop-compliance branch from 94e0192 to 87cc5d4 Compare December 13, 2023 16:23

Lord-McSweeney added desktop waiting-on-author Waiting on the PR author to make the requested changes labels Dec 14, 2023

Doomsdayrs force-pushed the freedesktop-compliance branch from e9c041c to 814299e Compare February 14, 2024 00:19

zefr0x suggested changes Feb 23, 2024

View reviewed changes

kjarosh self-assigned this Jul 22, 2024

kjarosh force-pushed the freedesktop-compliance branch from b0d754d to ed4c84f Compare July 22, 2024 23:22

kjarosh force-pushed the freedesktop-compliance branch from ed4c84f to 69462ff Compare August 1, 2024 22:11

kjarosh added waiting-on-review Waiting on review from a Ruffle team member and removed waiting-on-author Waiting on the PR author to make the requested changes labels Aug 1, 2024

kjarosh requested a review from torokati44 August 1, 2024 22:17

kjarosh mentioned this pull request Aug 2, 2024

desktop: Add a windows .msi installer #17335

Merged

kjarosh force-pushed the freedesktop-compliance branch 2 times, most recently from 15660e4 to 792f3d5 Compare August 2, 2024 10:31

torokati44 reviewed Aug 2, 2024

View reviewed changes

desktop/packages/linux/rs.ruffle.Ruffle.desktop Outdated Show resolved Hide resolved

torokati44 reviewed Aug 2, 2024

View reviewed changes

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml Show resolved Hide resolved

torokati44 reviewed Aug 2, 2024

View reviewed changes

desktop/packages/linux/rs.ruffle.Ruffle.metainfo.xml Outdated Show resolved Hide resolved

torokati44 approved these changes Aug 2, 2024

View reviewed changes

kjarosh force-pushed the freedesktop-compliance branch 2 times, most recently from 79170f6 to 53abefc Compare August 2, 2024 16:20

Korne127 reviewed Aug 3, 2024

View reviewed changes

desktop/packages/linux/rs.ruffle.Ruffle.desktop Outdated Show resolved Hide resolved

Korne127 approved these changes Aug 3, 2024

View reviewed changes

torokati44 force-pushed the freedesktop-compliance branch from 53abefc to d60a883 Compare August 3, 2024 12:15

Add freedesktop compliant appstream & metainfo

efe6cb5

kjarosh force-pushed the freedesktop-compliance branch 3 times, most recently from 7801282 to c00ead0 Compare August 3, 2024 14:22

kjarosh added 2 commits August 3, 2024 17:10

desktop: Update metadata

bc76e16

desktop: Update screenshots

5e18a00

kjarosh force-pushed the freedesktop-compliance branch from c00ead0 to 5e18a00 Compare August 3, 2024 15:44

kjarosh merged commit efe754c into ruffle-rs:master Aug 3, 2024
16 of 17 checks passed

kjarosh removed the waiting-on-review Waiting on review from a Ruffle team member label Aug 3, 2024

kjarosh mentioned this pull request Aug 3, 2024

desktop: Update screenshot URLs to point to a commit #17352

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add freedesktop compliant appstream & metainfo #11227

Add freedesktop compliant appstream & metainfo #11227

Doomsdayrs commented May 26, 2023 •

edited

Loading

Doomsdayrs commented May 30, 2023 •

edited

Loading

Dinnerbone left a comment

danielhjacobs Jun 14, 2023

Doomsdayrs Jun 30, 2023

torokati44 Jul 2, 2023

Doomsdayrs Jul 2, 2023

torokati44 Jul 2, 2023

Doomsdayrs Jul 22, 2023

Newbytee Nov 7, 2023

zefr0x Feb 13, 2024 •

edited

Loading

torokati44 Feb 14, 2024

torokati44 Feb 14, 2024

torokati44 commented Dec 13, 2023

torokati44 commented Dec 13, 2023

torokati44 commented Dec 13, 2023

Doomsdayrs commented Feb 14, 2024

jh-devv commented Feb 23, 2024

zefr0x Feb 23, 2024

Doomsdayrs Feb 23, 2024

zefr0x Feb 23, 2024 •

edited

Loading

zefr0x Feb 23, 2024

Doomsdayrs commented Feb 23, 2024

jh-devv commented Feb 26, 2024

kjarosh commented Jul 22, 2024 •

edited

Loading

torokati44 left a comment

kjarosh commented Aug 3, 2024

- <developer_name>ruffle-rs</developer_name>
+ <developer id="rs.ruffle">
+ <name translatable="no">ruffle-rs</name>
+ </developer>

Add freedesktop compliant appstream & metainfo #11227

Add freedesktop compliant appstream & metainfo #11227

Conversation

Doomsdayrs commented May 26, 2023 • edited Loading

Doomsdayrs commented May 30, 2023 • edited Loading

Dinnerbone left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zefr0x Feb 13, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

torokati44 commented Dec 13, 2023

torokati44 commented Dec 13, 2023

torokati44 commented Dec 13, 2023

Doomsdayrs commented Feb 14, 2024

jh-devv commented Feb 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zefr0x Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Doomsdayrs commented Feb 23, 2024

jh-devv commented Feb 26, 2024

kjarosh commented Jul 22, 2024 • edited Loading

torokati44 left a comment

Choose a reason for hiding this comment

kjarosh commented Aug 3, 2024

Doomsdayrs commented May 26, 2023 •

edited

Loading

Doomsdayrs commented May 30, 2023 •

edited

Loading

zefr0x Feb 13, 2024 •

edited

Loading

zefr0x Feb 23, 2024 •

edited

Loading

kjarosh commented Jul 22, 2024 •

edited

Loading