build: Replace manual AppImage bundling with appimage-builder script (#477)

* build: Tried to streamline and fix AppImage building

* build: Tried fixing build

* build: Added back version key

* build: Fixed AppImage name

* build: Fixed python bundling, fixed ELF uploading

* build: Don't upload a bunch of AppImage garbage files in the portable ELF version

* build: Fixed another wrong library path

* build: Removed old manual AppImage building scripts

.github/workflows/build.yml

@@ -180,6 +180,11 @@ jobs:
 
           sudo apt update
           sudo bash dist/get_deps_debian.sh
+          
+          sudo apt install -y python3-pip python3-setuptools patchelf desktop-file-utils libgdk-pixbuf2.0-dev fakeroot strace fuse
+          sudo wget https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage -O /usr/local/bin/appimagetool
+          sudo chmod +x /usr/local/bin/appimagetool
+          sudo pip3 install appimage-builder
 
           curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup-init.sh
           sh rustup-init.sh -y --default-toolchain none
@@ -192,16 +197,16 @@ jobs:
         run: |
           mkdir -p build
           cd build
-          CC=gcc-10 CXX=g++-10 cmake                  \
+          CC=gcc-11 CXX=g++-11 cmake                  \
             -DCMAKE_BUILD_TYPE=$BUILD_TYPE            \
-            -DCMAKE_INSTALL_PREFIX="$PWD/install/usr" \
+            -DCMAKE_INSTALL_PREFIX="/usr" 	      \
             -DCMAKE_C_COMPILER_LAUNCHER=ccache        \
             -DCMAKE_CXX_COMPILER_LAUNCHER=ccache      \
             -DCMAKE_C_FLAGS="-fuse-ld=lld"            \
             -DCMAKE_CXX_FLAGS="-fuse-ld=lld"          \
             -DRUST_PATH="$HOME/.cargo/bin/"           \
             ..
-          make -j 4 install
+          make -j 4 install DESTDIR=AppDir
 
       #- name: 📦 Bundle Flatpak
       #  run: |
@@ -212,33 +217,35 @@ jobs:
       #    flatpak-builder --jobs=4 --repo=imhex _flatpak dist/net.werwolv.ImHex.yaml --ccache --keep-build-dirs
       #    flatpak build-bundle imhex imhex.flatpak net.werwolv.ImHex stable
 
-      - name: 📦 Bundle DEB
-        run: |
-          cp -r build/DEBIAN build/install
-          dpkg-deb --build build/install
-          mv build/install.deb imhex.deb
-          rm -rf build/install/DEBIAN
-
-      - name: 📦 Bundle AppImage
-        run: |
-          dist/AppImage/package.sh build
-          mv build/ImHex-x86_64.AppImage imhex.AppImage
-
       - name: ⬆️ Upload ELF
         uses: actions/upload-artifact@v2
         with:
           name: Linux ELF
           path: |
-            build/install/*
+            build/AppDir/*
 
-      - name: ⬆️ Upload Flatpak
-        uses: actions/upload-artifact@v2
-        with:
-          name: Linux Flatpak
-          path: |
-            imhex.flatpak
+      - name: 📦 Bundle DEB
+        run: |
+          cp -r build/DEBIAN build/AppDir
+          dpkg-deb --build build/AppDir
+          mv build/AppDir.deb imhex.deb
+          rm -rf build/AppDir/DEBIAN
 
-      - name: ⬆️ Upload .deb
+      - name: 📦 Bundle AppImage
+        run: |
+          cd build
+          appimage-builder --recipe ../dist/AppImageBuilder.yml
+          mv ImHex-AppImage-x86_64.AppImage ../imhex.AppImage
+          cd ..
+
+      #- name: ⬆️ Upload Flatpak
+      #  uses: actions/upload-artifact@v2
+      #  with:
+      #    name: Linux Flatpak
+      #    path: |
+      #      imhex.flatpak
+
+      - name: ⬆️ Upload DEB
         uses: actions/upload-artifact@v2
         with:
           name: Linux DEB

dist/AppImage/Dockerfile

@@ -1,40 +0,0 @@
-FROM debian:bullseye-slim
-LABEL maintainer Example <example@example.com>
-
-ARG TAG=master
-ARG REPO=https://github.com/WerWolv/ImHex.git
-
-USER root
-
-# Bring packages up to date
-RUN apt-get update \
-    && apt-get upgrade -y \
-    && apt-get autoremove -y \
-    && apt-get install -y \
-        git \
-        cmake \
-        curl \
-        squashfs-tools
-
-# Fetch source and dependencies
-RUN mkdir -p /source \
-    && cd /source \
-    && git clone $REPO \
-    && cd ImHex \
-    && git checkout $TAG \
-    && git submodule update --init --recursive \
-    && cd /source/ImHex/dist \
-    && ./get_deps_debian.sh
-
-ARG CXX=g++-10
-
-# Build ImHex
-RUN mkdir -p /source/ImHex/build \
-    && cd /source/ImHex/build \
-    && cmake --install-prefix /usr -DCMAKE_BUILD_TYPE=Release .. \
-    && make -j
-
-# Prepare for AppImage
-RUN cd /source/ImHex/dist/AppImage \
-    && ./package.sh /source/ImHex/build \
-    && mv /source/ImHex/build/ImHex-x86_64.AppImage /

dist/AppImage/ImHex.desktop

@@ -1,6 +0,0 @@
-[Desktop Entry]
-Name=ImHex
-Exec=imhex
-Icon=imhex
-Type=Application
-Categories=Utility;

dist/AppImage/README.md

@@ -1,22 +0,0 @@
-# Building an AppImage
-There are two ways of building an AppImage for ImHex, using the provided
-tools here.
-
-If you want to create an AppImage and do not have a build to work from
-already, you can use docker to build ImHex and package an AppImage.
-
-Alternatively you can create an AppImage using an existing build.
-
-## Using docker
-First run `build.sh` to create a docker image. Then run `extract.sh` to get the
-AppImage out. This needs to be in two steps, as a docker build cannot copy
-files out. Nor can docker build use volume mounts.
-
-The environment variable TAG can be set to build for a specific git tag.
-Without the master branch is build.
-
-## Using an existing build
-Run `package.sh` with the build dir as an argument. E.g.:
-```
-./package.sh ../../build
-```

dist/AppImage/build.sh

@@ -1,16 +0,0 @@
-#!/bin/bash
-
-# Set the TAG environment variable to build a specific tag
-# Set the REPO environment variable to point at a different git repository
-
-# Make sure we're in the same directory as this script
-pushd $(dirname "$(realpath "$0")")
-
-BUILDARG=""
-SUFFIX=""
-[ -n "${TAG}" ] && BUILDARG="${BUILDARG} --build-arg=TAG=${TAG}" && SUFFIX=":${TAG}"
-[ -n "${REPO}" ] && BUILDARG="${BUILDARG} --build-arg=REPO=${REPO}"
-
-docker build ${BUILDARG} -t imhex-appimage-build${SUFFIX} .
-
-popd

dist/AppImage/extract.sh

@@ -1,26 +0,0 @@
-#!/bin/bash
-
-# Set the TAG environment variable to move to a versioned name while extracting
-
-# Make sure we're in the same directory as this script
-pushd $(dirname "$(realpath "$0")")
-
-SUFFIX=""
-[ -n "$TAG" ] && SUFFIX=":$TAG"
-
-# Remove old containers
-docker rm imhex 2>&1 > /dev/null
-
-docker run -d --name imhex imhex-appimage-build${SUFFIX} sleep 30 &
-sleep 15
-docker cp imhex:/ImHex-x86_64.AppImage .
-
-# Move to tagged name if $TAG set
-if [ -n "$TAG" ]; then
-    mv ImHex-x86_64.AppImage ImHex-${TAG}-x86_64.AppImage
-    echo -e "\nThe created AppImage can be found here:\n  $(pwd)/ImHex-${TAG}-x86_64.AppImage\n\n"
-else
-    echo -e "\nThe created AppImage can be found here:\n  $(pwd)/ImHex-x86_64.AppImage\n\n"
-fi
-
-popd

dist/AppImage/package.sh

@@ -1,58 +0,0 @@
-#!/bin/bash
-set -e # Exit on error
-set -o pipefail # Bash specific
-
-usage() {
-    echo "Tool to package an ImHex build into an AppImage"
-    echo
-    echo "Usage:"
-    echo "$0 <build dir>"
-    echo
-    exit
-}
-
-MYDIR=$(dirname "$(realpath "$0")")
-
-# Check is a build dir has been specified and it's a dir
-[ -z "$1" ] && usage
-[ -d "$1" ] || usage
-
-set -u # Throw errors when unset variables are used
-
-BUILDDIR=$1
-APPDIR=${BUILDDIR}/ImHex.AppDir
-APPIMAGE=${BUILDDIR}/ImHex-x86_64.AppImage
-
-# Prepare for AppImage
-## Fetch the needed AppImage binaries
-curl -L https://github.com/AppImage/AppImageKit/releases/download/13/AppRun-x86_64 -o ${MYDIR}/AppRun-x86_64
-curl -L https://github.com/AppImage/AppImageKit/releases/download/13/runtime-x86_64 -o ${MYDIR}/runtime-x86_64
-
-## Setup directory structure
-mkdir -p ${BUILDDIR}/ImHex.AppDir/usr/{bin,lib} ${BUILDDIR}/ImHex.AppDir/usr/share/imhex/plugins
-
-## Add ImHex files to structure
-cp ${BUILDDIR}/imhex ${APPDIR}/usr/bin
-cp ${BUILDDIR}/plugins/builtin/builtin.hexplug ${APPDIR}/usr/share/imhex/plugins
-cp ${MYDIR}/{AppRun-x86_64,ImHex.desktop,imhex.png} ${APPDIR}/
-mv ${BUILDDIR}/ImHex.AppDir/AppRun-x86_64 ${APPDIR}/AppRun
-chmod a+x ${BUILDDIR}/ImHex.AppDir/AppRun
-
-## Add all dependencies
-ldd ${BUILDDIR}/imhex | awk '/ => /{print $3}' | awk '!/(libc|libstdc++|libc++|libdl|libpthread|libselinux|ld-linux|libgdk)/' | xargs -I '{}' cp '{}' ${APPDIR}/usr/lib
-ldd ${BUILDDIR}/plugins/builtin/builtin.hexplug | awk '/ => /{print $3}' | awk '!/(libc|libstdc++|libc++|libdl|libpthread|libselinux|ld-linux|libgdk)/' | xargs -I '{}' cp '{}' ${APPDIR}/usr/lib
-ldd ${BUILDDIR}/lib/libimhex/libimhex.so | awk '/ => /{print $3}' | awk '!/(libc|libstdc++|libc++|libdl|libpthread|libselinux|ld-linux|libgdk)/' | xargs -I '{}' cp '{}' ${APPDIR}/usr/lib
-
-# Package it up as described here:
-# https://github.com/AppImage/AppImageKit#appimagetool-usage
-# under 'If you want to generate an AppImage manually'
-# This builds a v2 AppImage according to
-# https://github.com/AppImage/AppImageSpec/blob/master/draft.md#type-2-image-format
-mksquashfs ${APPDIR} ${BUILDDIR}/ImHex.squashfs -root-owned -noappend
-cat ${MYDIR}/runtime-x86_64 > ${APPIMAGE}
-cat ${BUILDDIR}/ImHex.squashfs >> ${APPIMAGE}
-chmod a+x ${APPIMAGE}
-
-if [ ! -f /.dockerenv ]; then
-    echo -e "\nThe created AppImage can be found here:\n  ${APPIMAGE}\n\n"
-fi

dist/AppImageBuilder.yml

@@ -0,0 +1,143 @@
+# appimage-builder recipe see https://appimage-builder.readthedocs.io for details
+version: 1
+script:
+  - rm -rf AppDir | true
+  - CC=gcc-11 CXX=g++11 cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
+  - make -j3 install DESTDIR=AppDir
+  - mv AppDir/usr/share/imhex/plugins AppDir/usr/bin/plugins
+  - mv AppDir/usr/constants AppDir/usr/bin/constants
+  - mv AppDir/usr/encodings AppDir/usr/bin/encodings
+  - mv AppDir/usr/includes AppDir/usr/bin/includes
+  - mv AppDir/usr/magic AppDir/usr/bin/magic
+  - mv AppDir/usr/patterns AppDir/usr/bin/patterns
+  - mkdir -p AppDir/usr/share/icons/hicolor/512x512
+  - cp AppDir/usr/share/pixmaps/imhex.png AppDir/usr/share/icons/hicolor/512x512/imhex.png
+  
+
+AppDir:
+  path: ./AppDir
+  app_info:
+    id: imhex
+    name: ImHex
+    icon: imhex
+    version: AppImage
+    exec: usr/bin/imhex
+    exec_args: $@
+  apt:
+    arch:
+    - amd64
+    allow_unauthenticated: true
+    sources:
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish main restricted
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish-updates main restricted
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish universe
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish-updates universe
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish multiverse
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish-updates multiverse
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ impish-backports main restricted
+        universe multiverse
+    - sourceline: deb http://security.ubuntu.com/ubuntu impish-security main restricted
+    - sourceline: deb http://security.ubuntu.com/ubuntu impish-security universe
+    - sourceline: deb http://security.ubuntu.com/ubuntu impish-security multiverse
+    include:
+    - libbz2-1.0:amd64
+    - libcap2:amd64
+    - libdbus-1-3:amd64
+    - libgpg-error0:amd64
+    - liblzma5:amd64
+    - libnss-mdns:amd64
+    - libpcre3:amd64
+    - libselinux1:amd64
+    - libtinfo6:amd64
+    - yaru-theme-icon
+  files:
+    include:
+    - /lib/x86_64-linux-gnu/libGLX.so.0
+    - /lib/x86_64-linux-gnu/libGLdispatch.so.0
+    - /lib/x86_64-linux-gnu/libLLVM-12.so.1
+    - /lib/x86_64-linux-gnu/libOpenGL.so.0
+    - /lib/x86_64-linux-gnu/libX11.so.6
+    - /lib/x86_64-linux-gnu/libXau.so.6
+    - /lib/x86_64-linux-gnu/libXcomposite.so.1
+    - /lib/x86_64-linux-gnu/libXcursor.so.1
+    - /lib/x86_64-linux-gnu/libXdamage.so.1
+    - /lib/x86_64-linux-gnu/libXdmcp.so.6
+    - /lib/x86_64-linux-gnu/libXext.so.6
+    - /lib/x86_64-linux-gnu/libXfixes.so.3
+    - /lib/x86_64-linux-gnu/libXi.so.6
+    - /lib/x86_64-linux-gnu/libXinerama.so.1
+    - /lib/x86_64-linux-gnu/libXrandr.so.2
+    - /lib/x86_64-linux-gnu/libXrender.so.1
+    - /lib/x86_64-linux-gnu/libXxf86vm.so.1
+    - /lib/x86_64-linux-gnu/libatk-1.0.so.0
+    - /lib/x86_64-linux-gnu/libatk-bridge-2.0.so.0
+    - /lib/x86_64-linux-gnu/libatspi.so.0
+    - /lib/x86_64-linux-gnu/libblkid.so.1
+    - /lib/x86_64-linux-gnu/libbrotlicommon.so.1
+    - /lib/x86_64-linux-gnu/libbrotlidec.so.1
+    - /lib/x86_64-linux-gnu/libbsd.so.0
+    - /lib/x86_64-linux-gnu/libcairo-gobject.so.2
+    - /lib/x86_64-linux-gnu/libcairo.so.2
+    - /lib/x86_64-linux-gnu/libdatrie.so.1
+    - /lib/x86_64-linux-gnu/libedit.so.2
+    - /lib/x86_64-linux-gnu/libelf.so.1
+    - /lib/x86_64-linux-gnu/libepoxy.so.0
+    - /lib/x86_64-linux-gnu/libffi.so.7
+    - /lib/x86_64-linux-gnu/libfontconfig.so.1
+    - /lib/x86_64-linux-gnu/libfreetype.so.6
+    - /lib/x86_64-linux-gnu/libfribidi.so.0
+    - /lib/x86_64-linux-gnu/libgcrypt.so.20
+    - /lib/x86_64-linux-gnu/libgdk-3.so.0
+    - /lib/x86_64-linux-gnu/libgdk_pixbuf-2.0.so.0
+    - /lib/x86_64-linux-gnu/libgio-2.0.so.0
+    - /lib/x86_64-linux-gnu/libglapi.so.0
+    - /lib/x86_64-linux-gnu/libglfw.so.3
+    - /lib/x86_64-linux-gnu/libglib-2.0.so.0
+    - /lib/x86_64-linux-gnu/libgmodule-2.0.so.0
+    - /lib/x86_64-linux-gnu/libgobject-2.0.so.0
+    - /lib/x86_64-linux-gnu/libgraphite2.so.3
+    - /lib/x86_64-linux-gnu/libgtk-3.so.0
+    - /lib/x86_64-linux-gnu/libharfbuzz.so.0
+    - /lib/x86_64-linux-gnu/libicudata.so.67
+    - /lib/x86_64-linux-gnu/libicuuc.so.67
+    - /lib/x86_64-linux-gnu/libjpeg.so.8
+    - /lib/x86_64-linux-gnu/liblz4.so.1
+    - /lib/x86_64-linux-gnu/libmagic.so.1
+    - /lib/x86_64-linux-gnu/libmbedcrypto.so.3
+    - /lib/x86_64-linux-gnu/libmbedtls.so.12
+    - /lib/x86_64-linux-gnu/libmbedx509.so.0
+    - /lib/x86_64-linux-gnu/libmd.so.0
+    - /lib/x86_64-linux-gnu/libmount.so.1
+    - /lib/x86_64-linux-gnu/libpango-1.0.so.0
+    - /lib/x86_64-linux-gnu/libpangocairo-1.0.so.0
+    - /lib/x86_64-linux-gnu/libpangoft2-1.0.so.0
+    - /lib/x86_64-linux-gnu/libpcre2-8.so.0
+    - /lib/x86_64-linux-gnu/libpixman-1.so.0
+    - /lib/x86_64-linux-gnu/libpng16.so.16
+    - /lib/x86_64-linux-gnu/libpython3.8.so.1.0
+    - /lib/x86_64-linux-gnu/libsensors.so.5
+    - /lib/x86_64-linux-gnu/libstdc++.so.6
+    - /lib/x86_64-linux-gnu/libsystemd.so.0
+    - /lib/x86_64-linux-gnu/libthai.so.0
+    - /lib/x86_64-linux-gnu/libuuid.so.1
+    - /lib/x86_64-linux-gnu/libvulkan.so.1
+    - /lib/x86_64-linux-gnu/libwayland-client.so.0
+    - /lib/x86_64-linux-gnu/libwayland-cursor.so.0
+    - /lib/x86_64-linux-gnu/libwayland-egl.so.1
+    - /lib/x86_64-linux-gnu/libxcb-dri2.so.0
+    - /lib/x86_64-linux-gnu/libxcb-dri3.so.0
+    - /lib/x86_64-linux-gnu/libxcb-present.so.0
+    - /lib/x86_64-linux-gnu/libxcb-sync.so.1
+    - /lib/x86_64-linux-gnu/libxkbcommon.so.0
+    - /lib/x86_64-linux-gnu/libxml2.so.2
+    - /lib/x86_64-linux-gnu/libxshmfence.so.1
+    - /lib/x86_64-linux-gnu/libzstd.so.1
+    exclude:
+    - usr/share/man
+    - usr/share/doc/*/README.*
+    - usr/share/doc/*/changelog.*
+    - usr/share/doc/*/NEWS.*
+    - usr/share/doc/*/TODO.*
+AppImage:
+  arch: x86_64
+  update-information: guess

dist/get_deps_debian.sh

@@ -12,8 +12,8 @@ fi
 
 apt install -y \
   build-essential       \
-  gcc-10                \
-  g++-10                \
+  gcc-11                \
+  g++-11                \
   lld                   \
   ${PKGCONF:-}          \
   cmake                 \
@@ -28,4 +28,4 @@ apt install -y \
   libgtk-3-dev          \
 
 echo "Please consider this before running cmake (useful on e.g. Ubuntu 20.04):"
-echo "export CXX=g++-10"
+echo "export CXX=g++-11"

dist/imhex.desktop

@@ -3,7 +3,7 @@ Name=ImHex
 Comment=ImHex Hex Editor
 GenericName=Hex Editor
 Exec=/usr/bin/imhex %U
-Icon=/usr/share/pixmaps/imhex.png
+Icon=imhex
 Type=Application
 StartupNotify=true
 Categories=GNOME;GTK;Development;