Create desktop file entry for linux app, fixes #53229 #60534

kenvandine · 2020-06-29T17:33:47Z

Description

This adds a generic app.desktop file as well as an icon.png to the linux template. These are necessary to create application launchers.

Related Issues

This fixes #53229

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I signed the CLA.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change. If not, delete the remainder of this section.
- I wrote a design doc: https://flutter.dev/go/template Replace this with a link to your design doc's short link
- I got input from the developer relations team, specifically from: Replace with the names of who gave advice
- I wrote a migration guide: https://flutter.dev/go/breaking-changes-template Replace this with a link to a pull request that adds the migration guide to https://flutter.dev/docs/release/breaking-changes

kenvandine · 2020-06-29T17:59:44Z

@robert-ancell one thing I wasn't sure about in this PR was where to install the files to, as we aren't creating something that can be installed via a typical install target but rather bundling. I just went with bundling the icon and desktop file relative to the data dir in the bundle. A packager should be able to handle relocating those as needed.

robert-ancell · 2020-06-30T01:55:15Z

packages/flutter_tools/templates/app/linux.tmpl/CMakeLists.txt.tmpl

@@ -79,6 +79,11 @@ if(PLUGIN_BUNDLED_LIBRARIES)
    COMPONENT Runtime)
 endif()

+install(FILES app.desktop DESTINATION "${INSTALL_BUNDLE_DATA_DIR}/applications" RENAME "{{projectName}}.desktop"


It might make sense to use {{linuxIdentifier}} once #60053 is landed.

robert-ancell · 2020-06-30T01:57:14Z

@robert-ancell one thing I wasn't sure about in this PR was where to install the files to, as we aren't creating something that can be installed via a typical install target but rather bundling. I just went with bundling the icon and desktop file relative to the data dir in the bundle. A packager should be able to handle relocating those as needed.

Makes sense to me. You could event drop the applications/ and icons/ dirs, as they seem a bit unnecessary with only one item in them.

robert-ancell

LGTM.

stuartmorgan-g

Is icon.png just an exact copy of an icon that's already in another template? (I'm assuming yes since there's not a CI failure, but I want to be sure since we're no longer adding new icons here.)

stuartmorgan-g · 2020-07-05T13:43:09Z

packages/flutter_tools/templates/app/linux.tmpl/CMakeLists.txt.tmpl

@@ -79,6 +79,11 @@ if(PLUGIN_BUNDLED_LIBRARIES)
    COMPONENT Runtime)
 endif()

+install(FILES app.desktop DESTINATION "${INSTALL_BUNDLE_DATA_DIR}/applications" RENAME "{{projectName}}.desktop"


Shouldn't this go to ~/Desktop, so that the app launches with an icon when run during development?

No, the user level .desktop files are stored at ~/.local/share/applications. I think ${INSTALL_BUNDLE_DATA_DIR} points to ~/.local/share probably. Whereas the root level .desktop files are stored at /usr/share/applications.

${INSTALL_BUNDLE_DATA_DIR} points to ~/.local/share probably.

It doesn't; see the rest of the install section of this CMake file if you are interested in the details.

stuartmorgan-g · 2020-07-05T13:44:29Z

packages/flutter_tools/templates/app/linux.tmpl/app.desktop.tmpl

+[Desktop Entry]
+Name={{projectName}}
+Comment={{description}}
+Icon=icon.png


It's renamed in the install step, so this won't be right. Also, doesn't this need to be the full path to the icon, added by a script during the install step?

stuartmorgan-g · 2020-07-05T13:45:59Z

packages/flutter_tools/templates/app/linux.tmpl/app.desktop.tmpl

+Name={{projectName}}
+Comment={{description}}
+Icon=icon.png
+Exec={{projectName}} %U


This should be the binary name, set from the install script, so it updates correctly if someone renames the binary.

stuartmorgan-g · 2020-07-05T13:46:57Z

packages/flutter_tools/templates/app/linux.tmpl/app.desktop.tmpl

+Terminal=false
+Type=Application
+Categories=Other;
+Keywords=Other;


Maybe put a comment on these two lines explaining what they are and where to get more information, since we expect people to change them presumably. We should assume most people won't be familiar with these files and provide help and/or links to instructions.

YazeedAlKhalaf

LGTM

zanderso · 2020-08-06T20:34:29Z

PR triage: What is the status of this PR? Is it ready to land?

stuartmorgan-g · 2020-08-06T21:11:16Z

PR triage: What is the status of this PR? Is it ready to land?

It's waiting for responses to/updates for my comments

stuartmorgan-g · 2020-09-17T20:42:41Z

@kenvandine We decided to close this and just do the set-icon part, right?

yozachar · 2020-09-18T03:57:34Z

Hi, thanks for taking interest in #53229!

@kenvandine We decided to close this and just do the set-icon part, right?

Was the label waiting for customer response meant for me?

kenvandine · 2020-09-29T17:37:49Z

@kenvandine We decided to close this and just do the set-icon part, right?

Yes, I'm closing this. Thanks!

Gustl22 · 2023-07-31T10:11:40Z

@kenvandine We decided to close this and just do the set-icon part, right?

What is meant by the "set-icon" part? Is that already taken care of? Thx for the info :D

stuartmorgan-g · 2023-07-31T14:26:12Z

What is meant by the "set-icon" part?

See #53229 (comment)

Create desktop file entry for linux app, fixes flutter#53229

a8d5e48

fluttergithubbot added the tool Affects the "flutter" command-line tool. See also t: labels. label Jun 29, 2020

googlebot added the cla: yes label Jun 29, 2020

kenvandine requested a review from robert-ancell June 29, 2020 17:57

robert-ancell reviewed Jun 30, 2020

View reviewed changes

robert-ancell approved these changes Jun 30, 2020

View reviewed changes

stuartmorgan-g reviewed Jul 5, 2020

View reviewed changes

YazeedAlKhalaf approved these changes Jul 23, 2020

View reviewed changes

zanderso added the waiting for customer response The Flutter team cannot make further progress on this issue until the original reporter responds label Sep 10, 2020

kenvandine closed this Sep 29, 2020

Create desktop file entry for linux app, fixes #53229 #60534

Create desktop file entry for linux app, fixes #53229 #60534

Uh oh!

Conversation

kenvandine commented Jun 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Checklist

Breaking Change

Uh oh!

kenvandine commented Jun 29, 2020

Uh oh!

robert-ancell Jun 30, 2020

Choose a reason for hiding this comment

Uh oh!

robert-ancell commented Jun 30, 2020

Uh oh!

robert-ancell left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Jul 5, 2020

Choose a reason for hiding this comment

Uh oh!

yozachar Jul 17, 2020

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Jul 19, 2020

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Jul 5, 2020

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Jul 5, 2020

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Jul 5, 2020

Choose a reason for hiding this comment

Uh oh!

YazeedAlKhalaf left a comment

Choose a reason for hiding this comment

Uh oh!

zanderso commented Aug 6, 2020

Uh oh!

stuartmorgan-g commented Aug 6, 2020

Uh oh!

stuartmorgan-g commented Sep 17, 2020

Uh oh!

yozachar commented Sep 18, 2020

Uh oh!

kenvandine commented Sep 29, 2020

Uh oh!

Gustl22 commented Jul 31, 2023

Uh oh!

stuartmorgan-g commented Jul 31, 2023

Uh oh!

Uh oh!

kenvandine commented Jun 29, 2020 •

edited

Loading

stuartmorgan-g left a comment •

edited

Loading