Feat appimage pack #6839

RubMaker · 2025-09-21T06:49:44Z

Before adding new features and new modules, please go to issues to submit the relevant feature description first.
Write good commit messages and use the same coding conventions as the rest of the project.
Please commit code to dev branch and we will merge into master branch in feature
Ensure your edited codes with four spaces instead of TAB.

增加新特性和新模块之前，请先到issues提交相关特性说明，经过讨论评估确认后，再进行相应的代码提交，避免做无用工作。
编写友好可读的提交信息，并使用与工程代码相同的代码规范，代码请用4个空格字符代替tab缩进。
请提交代码到dev分支，如果通过，我们会在特定时间合并到master分支上。
为了规范化提交日志的格式，commit消息，不要用中文，请用英文描述。

gemini-code-assist · 2025-09-21T06:50:04Z

Summary of Changes

Hello @RubMaker, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the xmake build system by adding robust support for AppImage packaging. It provides a streamlined workflow for creating self-contained Linux applications, handling everything from tool detection and dependency resolution to the generation of necessary AppImage metadata and the final executable. This feature simplifies application distribution on Linux by minimizing dependency issues and installation complexities.

Highlights

AppImage Packaging Support: Introduced comprehensive support for packaging applications into the AppImage format, enabling self-contained Linux executables.
Tool Detection and Integration: Added new modules to detect and integrate external tools like appimagetool, linuxdeploy, and linuxdeployqt for efficient AppImage creation.
Automated Dependency Collection: Implemented logic for automatic dependency collection, specifically tailored for Qt projects using linuxdeployqt, and a generic fallback using linuxdeploy or manual ldd analysis.
New xpack APIs: Added xpack.set_iconname and xpack.set_appimage_tool APIs to allow configuration of AppImage properties within xmake build scripts.
AppDir Structure and Metadata Generation: Developed functions to create the standard AppDir structure, generate .desktop files, AppRun scripts, and manage application icons, ensuring proper AppImage metadata.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces AppImage packaging support, a valuable addition. The implementation is well-structured, featuring a robust fallback mechanism for dependency collection. I've identified a couple of critical areas where the code could fail in certain environments, along with several opportunities to enhance error reporting and clarity. My comments focus on improving the robustness and maintainability of the new packaging logic.

gemini-code-assist · 2025-09-21T06:52:01Z

xmake/modules/detect/tools/find_linuxdeploy.lua

+        local homedir = os.getenv("HOME") 
+        local paths = {
+            "/usr/local/bin/linuxdeploy",
+            "/usr/bin/linuxdeploy",
+            "/opt/linuxdeploy/linuxdeploy",
+            path.join(os.tmpdir(), "linuxdeploy"),
+            path.join(homedir, "Downloads/linuxdeploy"),
+            path.join(homedir, "downloads/linuxdeploy"),
+            path.join(homedir, ".local/bin/linuxdeploy"),
+            path.join(homedir, "bin/linuxdeploy"),
+            "/snap/bin/linuxdeploy",
+            "/var/lib/flatpak/exports/bin/linuxdeploy",
+            path.join(homedir, ".local/share/flatpak/exports/bin/linuxdeploy"),
+            path.join(os.curdir(), "linuxdeploy"),
+            path.join(os.curdir(), "tools/linuxdeploy"),
+            path.join(os.curdir(), "bin/linuxdeploy")
+        }


There's a potential crash here if the HOME environment variable is not set. os.getenv("HOME") would return nil, and path.join(nil, ...) will likely cause an error when constructing the paths table. To prevent this, you should only attempt to construct paths using homedir after verifying it's not nil.

local homedir = os.getenv("HOME") local paths = { "/usr/local/bin/linuxdeploy", "/usr/bin/linuxdeploy", "/opt/linuxdeploy/linuxdeploy", path.join(os.tmpdir(), "linuxdeploy"), "/snap/bin/linuxdeploy", "/var/lib/flatpak/exports/bin/linuxdeploy", path.join(os.curdir(), "linuxdeploy"), path.join(os.curdir(), "tools/linuxdeploy"), path.join(os.curdir(), "bin/linuxdeploy") } if homedir then table.insert(paths, path.join(homedir, "Downloads/linuxdeploy")) table.insert(paths, path.join(homedir, "downloads/linuxdeploy")) table.insert(paths, path.join(homedir, ".local/bin/linuxdeploy")) table.insert(paths, path.join(homedir, "bin/linuxdeploy")) table.insert(paths, path.join(homedir, ".local/share/flatpak/exports/bin/linuxdeploy")) end

gemini-code-assist · 2025-09-21T06:52:01Z

xmake/modules/detect/tools/find_linuxdeployqt.lua

+        local homedir = os.getenv("HOME") 
+
+        local paths = {
+            "/usr/local/bin/linuxdeployqt",
+            "/usr/bin/linuxdeployqt",
+            "/opt/linuxdeployqt/linuxdeployqt",
+            path.join(os.tmpdir(), "linuxdeployqt"),
+            path.join(homedir, "Downloads/linuxdeployqt"),
+            path.join(homedir, "downloads/linuxdeployqt"),
+            path.join(homedir, ".local/bin/linuxdeployqt"),
+            path.join(homedir, "bin/linuxdeployqt"),
+            "/snap/bin/linuxdeployqt",
+            "/var/lib/flatpak/exports/bin/linuxdeployqt",
+            path.join(homedir, ".local/share/flatpak/exports/bin/linuxdeployqt"),
+            path.join(os.curdir(), "linuxdeployqt"),
+            path.join(os.curdir(), "tools/linuxdeployqt"),
+            path.join(os.curdir(), "bin/linuxdeployqt")
+        }


Similar to find_linuxdeploy.lua, this code is susceptible to a crash if the HOME environment variable is not set. os.getenv("HOME") will return nil, causing path.join(nil, ...) to fail. You should ensure homedir is valid before using it to construct paths.

local homedir = os.getenv("HOME") local paths = { "/usr/local/bin/linuxdeployqt", "/usr/bin/linuxdeployqt", "/opt/linuxdeployqt/linuxdeployqt", path.join(os.tmpdir(), "linuxdeployqt"), "/snap/bin/linuxdeployqt", "/var/lib/flatpak/exports/bin/linuxdeployqt", path.join(os.curdir(), "linuxdeployqt"), path.join(os.curdir(), "tools/linuxdeployqt"), path.join(os.curdir(), "bin/linuxdeployqt") } if homedir then table.insert(paths, path.join(homedir, "Downloads/linuxdeployqt")) table.insert(paths, path.join(homedir, "downloads/linuxdeployqt")) table.insert(paths, path.join(homedir, ".local/bin/linuxdeployqt")) table.insert(paths, path.join(homedir, "bin/linuxdeployqt")) table.insert(paths, path.join(homedir, ".local/share/flatpak/exports/bin/linuxdeployqt")) end

gemini-code-assist · 2025-09-21T06:52:01Z

.marscode/deviceInfo.json

+{
+  "deviceId": "1d865d85971033dbc6e2146fc84e4bab560676c51efb52db347df5c3d503bafb"
+}


This file appears to contain a user-specific or machine-specific device ID. Such files should not be committed to the version control system as they can expose sensitive information and are not relevant to other developers. Please remove this file from the repository and add .marscode/ to your .gitignore file to prevent it from being accidentally committed in the future.

这里没改

gemini-code-assist · 2025-09-21T06:52:01Z

xmake/plugins/pack/appimage/main.lua

+function _get_appimagetool()
+    local appimagetool = find_tool("appimagetool")
+    if not appimagetool then
+        assert(appimagetool, "appimagetool need to be downloaded!")


The assert message "appimagetool need to be downloaded!" could be more instructive for the user. A clearer message would help them resolve the issue faster.

assert(appimagetool, "appimagetool not found. Please install it and ensure it is in your PATH.")

gemini-code-assist · 2025-09-21T06:52:01Z

xmake/plugins/pack/appimage/main.lua

+    if not ok then
+        return false
+    end


The err variable returned by os.iorunv is not used. Logging this error when ok is false would provide valuable information for debugging why linuxdeployqt failed.

if not ok then wprint("Failed to run linuxdeployqt: %s", err) return false end

gemini-code-assist · 2025-09-21T06:52:02Z

xmake/plugins/pack/appimage/main.lua

+    if not ok then
+        return false
+    end


The err variable from os.iorunv is ignored. It would be beneficial for debugging to log the error message if the linuxdeploy command fails.

if not ok then wprint("Failed to run linuxdeploy: %s", err) return false end

gemini-code-assist · 2025-09-21T06:52:02Z

xmake/plugins/pack/appimage/main.lua

+        if linuxdeployqt then
+            deps_collected = _collect_qt_deps_with_linuxdeployqt(package, appdir, linuxdeployqt)
+        else
+            print("linuxdeployqt not available, will try fallback methods")


Using wprint (warning print) instead of print for this message would be more consistent with how warnings are handled elsewhere in the file and would make it clearer to the user that this is a non-critical fallback situation.

wprint("linuxdeployqt not available, will try fallback methods")

gemini-code-assist · 2025-09-21T06:52:02Z

xmake/plugins/pack/appimage/main.lua

+        if linuxdeploy then
+            deps_collected = _collect_deps_with_linuxdeploy(package, appdir, linuxdeploy)
+        else
+            print("linuxdeploy not available")


For consistency and better visibility, consider using wprint to log this warning, similar to other warnings in this script. Also, adding context that a fallback will be attempted would be helpful.

wprint("linuxdeploy not available, will try fallback methods")

waruqi · 2025-09-21T08:02:13Z

xmake/includes/xpack/xmake.lua

        -- set nsis display icon
        "xpack.set_nsis_displayicon",
+        -- set appimage icon name
+        "xpack.set_iconname",


这里也是

这里还没改

waruqi · 2025-09-21T08:02:46Z

xmake/modules/detect/tools/find_linuxdeploy.lua

+    local program = find_program("linuxdeploy", opt)
+
+    -- if not found, check common installation paths
+    if not program then


这里都没改

waruqi · 2025-09-21T08:02:58Z

xmake/modules/detect/tools/find_linuxdeployqt.lua

+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--


qt相关的先删了

waruqi · 2025-09-21T08:03:15Z

xmake/modules/detect/tools/find_appimagetool.lua

+
+    -- if not found, check common installation paths
+    if not program then
+        local paths = {


这里也没改，看下之前的 review 信息

waruqi · 2025-09-21T08:03:40Z

xmake/plugins/pack/appimage/main.lua

+end
+
+-- collect Qt dependencies with linuxdeployqt (rewritten)
+function _collect_qt_deps_with_linuxdeployqt(package, appdir, linuxdeployqt)


这里都没删，qt 的

waruqi · 2025-09-22T14:11:11Z

xmake/modules/detect/tools/find_linuxdeploy.lua

+-- limitations under the License.
+--
+-- Copyright (C) 2015-present, Xmake Open Source Community.
+--


waruqi · 2025-09-22T14:11:45Z

xmake/plugins/pack/appimage/main.lua

+    end
+    return appimagetool
+end
+-- get linuxdeploy tool


不要挤一起，适当换行下。。

waruqi · 2025-09-22T14:12:05Z

xmake/plugins/pack/appimage/main.lua

+-- get linuxdeploy tool
+function _get_linuxdeploy()
+    local linuxdeploy = assert(find_tool("linuxdeploy"), "linuxdeploy not found!Pease install it in Downloads folder.")
+    return linuxdeploy


waruqi · 2025-09-22T14:12:51Z

xmake/plugins/pack/appimage/main.lua

+    end
+    -- execute install commands
+    for _, cmd in ipairs(installcmds) do
+        os.exec(cmd)


这里也没改，看下最早我的 review ，直接走 runcmds

waruqi · 2025-10-07T04:49:31Z

这里还有一些 review 没有处理

Issues-translate-bot · 2025-10-07T05:36:14Z

Bot detected the issue body's language is not English, translate it automatically.

There are still some reviews that are not processed

gemini-code-assist bot reviewed Sep 21, 2025

View reviewed changes

waruqi reviewed Sep 21, 2025

View reviewed changes

waruqi reviewed Sep 22, 2025

View reviewed changes

xmake/plugins/pack/appimage/main.lua

end

return appimagetool

end

-- get linuxdeploy tool

Copy link

Member

waruqi Sep 22, 2025

Choose a reason for hiding this comment

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

不要挤一起，适当换行下。。

waruqi reviewed Sep 22, 2025

View reviewed changes

RubMaker force-pushed the feat-appimage branch 2 times, most recently from 1ef0c63 to 57bd2a6 Compare September 29, 2025 23:12

RubMaker added 13 commits September 30, 2025 12:23

init

5e2c151

add appimage pack for common and qt

2ccccd3

dmg with print

bc12c5b

add dmg pack qt and common

cbbed63

remove a print for dmg

9e3fa0e

remove some print

03b71c0

remove dmg part

ede5c71

some modify for appimage

1735608

modified appimage pack

fad2554

remove qt pack appimage

0e2fb5a

remove qt func

5b12257

a version can run

8f30de8

rebuidl appdir for appimage

22ad6db

RubMaker force-pushed the feat-appimage branch from 57bd2a6 to 22ad6db Compare September 30, 2025 04:24

Uh oh!

Feat appimage pack #6839

Are you sure you want to change the base?

Feat appimage pack #6839

Uh oh!

Conversation

RubMaker commented Sep 21, 2025

Uh oh!

gemini-code-assist bot commented Sep 21, 2025

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 21, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waruqi commented Oct 7, 2025

Uh oh!

Issues-translate-bot commented Oct 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants