CPack: Refactor AppImage and Apple DMG Generation #7252

tresf · 2024-05-12T01:17:21Z

Features:

Simplifies Mac and Linux packaging command to simply: make package

- make install && make appimage
- make install && make dmg
+ make package
# -- AppImage create: /__w/lmms/lmms/build/lmms-1.3.0-alpha.1.638+pr7252.gaaa9b4816-linux-x86_64.AppImage

Adds new WANT_DEBUG_CPACK flag to easily show detailed console messages about packaging

cmake .. -DWANT_DEBUG_CPACK=true

  Developer options
  -----------------------------------------
  * Debug FP exceptions               : Disabled
  * Debug using AddressSanitizer      : Disabled
  * Debug using ThreadSanitizer       : Disabled
  * Debug using MemorySanitizer       : Disabled
  * Debug using UBSanitizer           : Disabled
+ * Debug packaging commands          : Enabled

Preserves old CPack TGZ behavior through a hidden flag, WANT_CPACK_TARBALL. Does anyone use this?

Adds new CPACK_TOOL parameter to switch between .AppImage (default) and .run (experimental)

export CPACK_TOOL=makeself
make package
# -- Installer create: /__w/lmms/lmms/build/lmms-1.3.0-alpha.1.638+pr7252.gaaa9b4816-linux-x86_64.run

Packaging now requires CMake 3.19+

TODO:

BUGS:

Fix background missing for DMG
Fix AppImages not building for Linux
WANT_DEBUG_CPACK is incorrectly toggled in CI. https://github.com/LMMS/lmms/actions/runs/9131345271/job/25110338288. Closed via 82a3aa6.

STRETCH GOALS:

Port project from linuxdeployqt to linuxdeploy
Examples:
- pbek/QOwnNotes (thank you!)
- wireshark/wireshark@34ce99f (thank you!)
Remove all references to linuxdeployqt (in favor of linuxdeploy)
Add ARM64 AppImage
- Can linuxdeploy support a cross-compilation environment ? linuxdeploy/linuxdeploy#258
- On hold until GitHub actions Linux ARM64 runners are released to the general public. https://github.com/orgs/community/discussions/73040#discussioncomment-9661482

Background:

Click to expand

The AppImage and Apple DMG installers historically (confusingly) require make install to be run prior to making packages. This PR is a proposal to remove that by switching to CPack.
- Utilizes make package now, just like Windows does
- Mac utilizes CPACK_GENERATOR of ~~DragNDrop~~ Bundle which will create a DMG without the need for node's appdmg package (still requires macdeployqt)
- Linux will utilize CPACK_GENERATOR of "External", which will use custom CMake commands to replace package_linux.sh (still requires linuxdeployqt).

PhysSong · 2024-05-15T01:37:00Z

FYI, CMake homepage lists the official PPA and pip package as alternative installation methods.

messmerd · 2024-05-15T02:09:31Z

@tresf I could update the Linux image with a newer CMake using the official PPA if you want. That might be easiest and also won't impact build times

Rossmaxx · 2024-05-15T06:22:26Z

can we use the PPA for mingw ci image too?

messmerd · 2024-05-15T14:09:24Z

yeah, I'll take that offer. 🤣

I'll try to do it sometime today

can we use the PPA for mingw ci image too?

Yes, I think so, though I don't think it will be needed for this PR

tresf · 2024-05-15T16:22:56Z

Yes, I think so, though I don't think it will be needed for this PR

Actually, we can justify it here since bad79a8.

tresf · 2024-05-16T04:46:39Z

I've marked this ready for review because I think it's in pretty good shape. (artifacts should start generating once cmake is updated).

ARM64.AppImage.mp4

- Refactor BashCompletion.cmake - Add initial support for Linux AppImages (untested) - Add debug flags for cpack

tresf · 2025-01-30T23:01:08Z

I just tried it again on Linux Mint 22 with the latest commit, and the icon does not show up.

Yeah same. I noticed that linuxdeploy creates an icon folder for 256x256 but we don't provide these icons, so I've added them in a 1x to see if behavior changes.

Edit: Still doesn't work. 😢

tresf · 2025-01-31T03:27:31Z

I've reverted all trial-and-error attempts at fixing the AppImage icons generated from CI.

AppImages generated directly in Linux Mint 22 show the icon
AppImages downloaded from CI don't show the icon

One difference I noticed is that the GitHub runners have SELinux enabled, so I may experiment with that next, but I'm running out of steam on fixing this issue.

tresf · 2025-01-31T18:02:22Z

I've reverted all trial-and-error attempts at fixing the AppImage icons generated from CI.

AppImages generated directly in Linux Mint 22 show the icon

AppImages downloaded from CI don't show the icon

I've decided to reach out to the Linux Mint community to see if they can shed some light on where to look next. https://forums.linuxmint.com/viewtopic.php?t=439346.

tresf · 2025-01-31T20:42:29Z

By shimming a custom script into /usr/share/thumbnailers/xapp-appimage-thumbnailer.thumbnailer I can get some more information about how Mint's Nemo calls its thumbnailing service...

[Thumbnailer Entry]
TryExec=xapp-appimage-thumbnailer
# Exec=xapp-appimage-thumbnailer -i %i -o %o -s %s
Exec=script -qc 'echo "xapp-appimage-thumbnailer -i %i -o %o -s %s"' /tmp/thumbnailer
MimeType=application/vnd.appimage;

touch /tmp/thumbnailer && tail -f /tmp/thumbnailer

Which shows something like this:

xapp-appimage-thumbnailer -i /home/owner/Downloads/lmms-1.2.2-linux-x86_64.AppImage
                          -o /tmp/.gnome_desktop_thumbnail.6Z6Q02
                          -s 256

I can reliably get an error for some of our AppImages, I'm not sure how I missed this before:

- xapp-thumbnails PIL load error:  cannot identify image file '/dev/shm/tmpnhjrczzb/out/.DirIcon'

In lieu of this new information, I'm doing the following via 8e7f554:

Reverting to PNG to avoid double-symlink and/or SVG related errors
Reverting our icon to 256x256 as Nemo prefers

However, this isn't conclusive. When testing the above thumbnail shim, I've noticed for AppImages that have a clock/hourglass icon, the thumbnailer never gets called. This leads me to believe that a Nemo background service is hanging before the thumbnail service starts. This is further supported by the following statement from @messmerd on Discord:

@tresf I wonder if there's an issue with Linux Mint? I'm pretty sure half of these icons weren't showing up yesterday:

Will continue testing once the CI is done building.

messmerd · 2025-01-31T21:46:02Z

With the latest commit, the icon appears to be stuck in some loading state:

tresf · 2025-01-31T21:50:37Z

I found a workaround:

touch ~/Downloads/*.AppImage

Click to show video...

MIDAS_TOUCH_QBERT_SWEAR_WORDS.mov

tresf · 2025-01-31T22:02:28Z

Bug filed upstream linuxmint/nemo#3522

messmerd

Looks good to me. No issues discovered during testing except the aforementioned VST issue with the AppImage CI builds.

Rudxain · 2025-02-02T01:57:20Z

Props to everyone who worked on this! I can see the thumbnail issue was very frustrating

* SharedMemory: Make key optional, shorter on macOS * Add getters for shared memory size * macOS: Fix linking regression for RemoteZynAddSubFx introduced with #7252 --------- Co-authored-by: Dalton Messmer <[email protected]>

@rpath

* CPack: Refactor AppImage and Apple DMG Generation * Switch from linuxdeployqt to linuxdelpoy * Add ARM64 AppImage support * Add support for `.run` installers using `makeself`, an alternative to AppImage * Refactor BashCompletion.cmake * Enable CPack debugging via `WANT_DEBUG_CPACK` * Add `download_binary`, `create_symlink` macros * Qt6: Fix @rpath bug on macOS * Detect and bundle LV2 UI Suil modules (Related LMMS#7201) * Allow remote plugins to honor `LMMS_PLUGIN_DIR` * Add .github/workflows/deps-ubuntu-24.04-gcc.txt * Fix waveforms FileDialog Co-authored-by: Dalton Messmer <[email protected]>

…S#7681) * SharedMemory: Make key optional, shorter on macOS * Add getters for shared memory size * macOS: Fix linking regression for RemoteZynAddSubFx introduced with LMMS#7252 --------- Co-authored-by: Dalton Messmer <[email protected]>

This comment was marked as outdated.

Sign in to view

tresf changed the title ~~CPack: Proof of concept for making Apple installers~~ CPack: Refactor AppImage and Apple DMG Generation May 14, 2024

This comment was marked as outdated.

Sign in to view

tresf marked this pull request as ready for review May 16, 2024 04:40

tresf mentioned this pull request May 16, 2024

Update MinGW CI to 20.04 #7256

Closed

tresf added 13 commits May 16, 2024 17:02

CPack: Proof of concept for making Apple installers

aa13e0b

Formatting, wording

fefa368

Remove appdmg dependency

349a13f

Shellcheck

3a8174e

Shellcheck2

08143b4

Document .DS_Store better

87590ae

Try to fix tiff file

a6f50ff

Initial refactoring

615927c

Minor changes

5c4a986

Convert apple package script to cmake

2289655

Fix appdmg

ae049e5

Order of operations: Fix broken DMG

8443819

Initial Linux support:

d95d126

- Refactor BashCompletion.cmake - Add initial support for Linux AppImages (untested) - Add debug flags for cpack

tresf added 3 commits January 30, 2025 18:11

Add back in --icon-file

be77275

Directly deploy the 64x64 .DirIcon

901175c

Give up

0918a5f

tresf added 5 commits January 31, 2025 02:22

Try 64x64 one more time

2dfbf57

Revert 64x64 DirIcon; Try to disable SELinux

4e3e5f8

Try to disable SELinux (again)

d1bbd0d

Revert broken commands

de60afb

Typo

07af0ee

tresf added 2 commits January 31, 2025 14:01

Going insane

92001f0

Switch back to 256 PNGs, document Nemo size preference, delete SVG

8e7f554

Fix waveforms FileDialog

7c9c825

messmerd approved these changes Feb 1, 2025

View reviewed changes

tresf merged commit 10bdf12 into LMMS:master Feb 1, 2025
9 of 10 checks passed

tresf deleted the cpack branch February 1, 2025 09:02

tresf mentioned this pull request Feb 3, 2025

SharedMemory: Make key optional, default to shorter UID on macOS #7681

Merged

tresf mentioned this pull request Jul 3, 2025

Nightly Appimages no longer work on Debian #7972

Closed

tresf mentioned this pull request Sep 4, 2025

AppImage: Un-pollute /usr/lib #8053

Merged

13 tasks

tresf mentioned this pull request Oct 21, 2025

Some icons sometimes disappear after minimizing LMMS for some time. #7979

Open

1 task

Uh oh!

CPack: Refactor AppImage and Apple DMG Generation #7252

CPack: Refactor AppImage and Apple DMG Generation #7252

Uh oh!

Conversation

tresf commented May 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

PhysSong commented May 15, 2024

Uh oh!

messmerd commented May 15, 2024

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

Rossmaxx commented May 15, 2024

Uh oh!

messmerd commented May 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tresf commented May 15, 2024

Uh oh!

tresf commented May 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tresf commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tresf commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tresf commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tresf commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

messmerd commented Jan 31, 2025

Uh oh!

tresf commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tresf commented Jan 31, 2025

Uh oh!

messmerd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Rudxain commented Feb 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

tresf commented May 12, 2024 •

edited

Loading

messmerd commented May 15, 2024 •

edited

Loading

tresf commented May 16, 2024 •

edited

Loading

tresf commented Jan 30, 2025 •

edited

Loading

tresf commented Jan 31, 2025 •

edited

Loading

tresf commented Jan 31, 2025 •

edited

Loading

tresf commented Jan 31, 2025 •

edited

Loading

tresf commented Jan 31, 2025 •

edited

Loading