build: build appimage using docker instead of github CI (#1358)

.github/workflows/build.yml

@@ -332,76 +332,41 @@ jobs:
     runs-on: ubuntu-22.04
     name: ⬇️ AppImage
     steps:
-
       - name: 🧰 Checkout
         uses: actions/checkout@v3
         with:
           submodules: recursive
 
-      - name: 📜 Setup ccache
-        uses: hendrikmuhs/ccache-action@v1.2
-        with:
-          key: appimage-ccache-${{ github.run_id }}
-          restore-keys: appimage-ccache
-          max-size: 1G
-
-      - name: 📜 Restore CMakeCache
+      - name: 📁 Restore docker /cache
         uses: actions/cache@v3
         with:
-          path: |
-            build-appimage/CMakeCache.txt
-          key: appimage-cmakecache-${{ hashFiles('**/CMakeLists.txt') }}
+          path: cache
+          key: appimage-ccache-${{ github.run_id }}
+          restore-keys: appimage-cache
+      
+      - name: 🐳 Inject /cache into docker
+        uses: reproducible-containers/buildkit-cache-dance@v2.1.2
+        with:
+          cache-source: cache
+          cache-target: /cache
 
-      - name: ⬇️ Install dependencies
+      - name: 🛠️ Build using docker
         run: |
-          sudo apt update
-          sudo bash dist/get_deps_debian.sh
+          docker buildx build . -f dist/appimage/Dockerfile --progress=plain --build-arg "BUILD_TYPE=$BUILD_TYPE" \
+          --build-arg "GIT_COMMIT_HASH=$GITHUB_SHA" --build-arg "GIT_BRANCH=${GITHUB_REF##*/}" --output out
 
-          sudo apt install -y python3-pip python3-setuptools desktop-file-utils libgdk-pixbuf2.0-dev fuse ninja-build
-          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 git+https://github.com/iTrooz/appimage-builder@dpkg-package-versions
-
-      - name: 📜 Set version variable
-        run: |
-          echo "IMHEX_VERSION=`cat VERSION`" >> $GITHUB_ENV
-
-      # AppImage cmake build
-      - name: 🛠️ Build
-        run: |
-          mkdir -p build-appimage
-          cd build-appimage
-          CC=gcc-12 CXX=g++-12 cmake -G "Ninja"           \
-            -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}        \
-            -DCMAKE_INSTALL_PREFIX="/usr"                 \
-            -DCMAKE_C_COMPILER_LAUNCHER=ccache            \
-            -DCMAKE_CXX_COMPILER_LAUNCHER=ccache          \
-            -DIMHEX_PATTERNS_PULL_MASTER=ON               \
-            -DIMHEX_COMMIT_HASH_SHORT="${GITHUB_SHA::7}"  \
-            -DIMHEX_COMMIT_HASH_LONG="${GITHUB_SHA}"      \
-            -DIMHEX_COMMIT_BRANCH="${GITHUB_REF##*/}"     \
-            -DIMHEX_ENABLE_LTO=ON                         \
-            -DIMHEX_PLUGINS_IN_SHARE=ON                   \
-            ..
-          DESTDIR=AppDir ninja install
-
-      - name: 📦 Bundle AppImage
-        run: |
-          cd build-appimage
-          export VERSION=${{env.IMHEX_VERSION}}
-          appimage-builder --recipe ../dist/AppImageBuilder.yml
 
       - name: ⬆️ Upload AppImage
         uses: actions/upload-artifact@v3
         with:
           name: Linux AppImage x86_64
-          path: 'build-appimage/*.AppImage'
+          path: 'out/*.AppImage'
 
       - name: ⬆️ Upload AppImage zsync
         uses: actions/upload-artifact@v3
         with:
           name: Linux AppImage zsync x86_64
-          path: 'build-appimage/*.AppImage.zsync'
+          path: 'out/*.AppImage.zsync'
 
   # ArchLinux build
   archlinux-build:

dist/AppImageBuilder.yml

@@ -20,7 +20,7 @@ AppDir:
     - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ jammy-updates universe
     - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ jammy multiverse
     - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ jammy-updates multiverse
-    - sourceline: deb http://.archive.ubuntu.com/ubuntu/ jammy-backports main restricted
+    - sourceline: deb http://us.archive.ubuntu.com/ubuntu/ jammy-backports main restricted
         universe multiverse
     - sourceline: deb http://security.ubuntu.com/ubuntu jammy-security main restricted
     - sourceline: deb http://security.ubuntu.com/ubuntu jammy-security universe

dist/appimage/Dockerfile

@@ -0,0 +1,85 @@
+FROM ubuntu:22.04 as build
+
+# Used to invalidate layer cache but not mount cache
+# See https://github.com/moby/moby/issues/41715#issuecomment-733976493
+ARG UNIQUEKEY 1
+
+COPY dist/get_deps_debian.sh /tmp
+RUN --mount=type=cache,target=/var/apt/cache <<EOF
+# Install apt dependencies
+set -xe
+
+apt update
+
+# general deps
+apt install -y ccache git wget
+# appimage tools deps
+apt install -y python3-pip python3-setuptools desktop-file-utils libgdk-pixbuf2.0-dev fuse ninja-build
+apt install -y squashfs-tools zsync
+
+# imhex deps
+/tmp/get_deps_debian.sh
+EOF
+
+RUN --mount=type=cache,target=/cache <<EOF
+# Download appimage-builder
+set -xe
+
+mkdir -p /cache/bin
+wget -nc https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage -O /cache/bin/appimagetool || true
+chmod +x /cache/bin/appimagetool
+
+pip3 install git+https://github.com/AppImageCrafters/appimage-builder@f38699e
+EOF
+
+ENV PATH="/cache/bin/:${PATH}"
+
+# Copy Imhex source
+COPY . /imhex
+
+ARG LTO=ON
+ARG BUILD_TYPE=RelWithDebInfo
+ARG GIT_COMMIT_HASH
+ARG GIT_BRANCH
+WORKDIR /build
+SHELL ["bash", "-c"] # Ubuntu sh doesnt support string substitution
+RUN <<EOF
+# Prepare ImHex build
+set -xe
+
+CC=gcc-12 CXX=g++-12 cmake -G "Ninja"                  \
+    -DCMAKE_BUILD_TYPE=${BUILD_TYPE}                   \
+    -DCMAKE_INSTALL_PREFIX="/usr"                      \
+    -DCMAKE_C_COMPILER_LAUNCHER=ccache                 \
+    -DCMAKE_CXX_COMPILER_LAUNCHER=ccache               \
+    -DIMHEX_PATTERNS_PULL_MASTER=ON                    \
+    -DIMHEX_COMMIT_HASH_SHORT="${GIT_COMMIT_HASH::7}"  \
+    -DIMHEX_COMMIT_HASH_LONG="${GIT_COMMIT_HASH}"      \
+    -DIMHEX_COMMIT_BRANCH="${GIT_BRANCH}"              \
+    -DIMHEX_ENABLE_LTO=${LTO}                          \
+    -DIMHEX_PLUGINS_IN_SHARE=ON                        \
+    /imhex
+EOF
+
+ENV CCACHE_DIR /cache/ccache
+RUN --mount=type=cache,target=/cache <<EOF
+# Build Imhex
+set -xe
+
+ccache -zs
+DESTDIR=AppDir ninja install
+ccache -s
+EOF
+
+RUN <<EOF
+# Package ImHex as AppImage
+set -xe
+
+export VERSION=$(cat /imhex/VERSION)
+appimage-builder --recipe /imhex/dist/AppImageBuilder.yml
+EOF
+
+FROM scratch
+
+# Copy build artifact
+COPY --from=build /build/*.AppImage /build/*.AppImage.zsync ./