gitlab-ci, build/linux: Move Flatpak CI code to scripts that works

This will make easier to debug problems locally if needed and
have the potential to reduce the first barrier for Linux newbies.

.gitlab-ci.yml

@@ -332,13 +332,7 @@ gimp-debian-x64:
       junit: "_build${ARTIFACTS_SUFFIX}/meson-logs/testlog.junit.xml"
     expire_in: 2 days
 
-include: 'https://gitlab.gnome.org/GNOME/citemplates/raw/master/flatpak/flatpak_ci_initiative.yml'
 gimp-flatpak-x64:
-# See: https://gitlab.gnome.org/GNOME/Initiatives/-/wikis/DevOps-with-Flatpak
-# XXX This job is mostly the same as .flatpak job of
-# flatpak_ci_initiative.yml so far, except that we removed the
-# automatic tests since rebuilding plug-ins was not working and
-# one of the test (save-and-export) requires plug-ins to be built.
   extends: .default
   rules:
     - if: '$CI_MERGE_REQUEST_LABELS =~ /.*5. Flatpak package.*/'
@@ -349,59 +343,30 @@ gimp-flatpak-x64:
   tags:
     - flatpak
   image: 'quay.io/gnome_infrastructure/gnome-runtime-images:gnome-master'
-  variables:
+  # FIXME: Flatpak design mandates to build everything from scratch on CI
-    # Replace with your manifest path
+  # See: https://gitlab.gnome.org/Infrastructure/Infrastructure/-/issues/1502
-    MANIFEST_PATH: "build/linux/flatpak/org.gimp.GIMP-nightly.json"
+  cache: []
-    RUNTIME_REPO: "https://nightly.gnome.org/gnome-nightly.flatpakrepo"
+    # key: ${CI_JOB_NAME}-pkg
-    # Replace with your application name, as written in the manifest
+    # paths:
-    FLATPAK_MODULE: "gimp"
+        # .flatpak-builder/downloads
-    APP_ID: "org.gimp.GIMP"
+        # .flatpak-builder/git
-    BUNDLE: "gimp-git.flatpak"
+    # !reference [.default, cache]
-  cache:
-    - key: ${CI_JOB_NAME}-pkg
-      paths:
-        - .flatpak-builder/downloads
-        - .flatpak-builder/git
-    - !reference [.default, cache]
   script:
-    # Report the installed versions of the runtime
+    # FIXME: Flatpak design mandates to build monolithically (aka in one job) on CI
-    - flatpak info org.gnome.Platform
+    - bash build/linux/flatpak/1_build-deps-flatpak.sh
-    - flatpak info org.gnome.Sdk
+    - bash build/linux/flatpak/2_build-gimp-flatpak.sh
-
+    # FIXME: Flatpak design mandates to run in the same CI job even the dist commands!
-    # Install LLVM/Clang
+    - bash build/linux/flatpak/4_dist-gimp-flatpak.sh
-    - flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
-    - flatpak install --user flathub org.freedesktop.Sdk.Extension.llvm17 -y
-
-    # Print the date, since appstream depends on local timezone
-    - date && date -u
-
-    # Configure manifest
-    - flatpak build-init ${GIMP_PREFIX} $APP_ID org.gnome.Sdk org.gnome.Platform
-    - flatpak build ${GIMP_PREFIX} meson setup _build${ARTIFACTS_SUFFIX} || echo "Generated log"
-    - GIMP_APP_VERSION=$(grep 'Project version' _build${ARTIFACTS_SUFFIX}/meson-logs/meson-log.txt | head -1 | sed -e 's/^.*[^0-9]\([0-9]*\.[0-9]*\.[0-9]*\).*$/\1/' -e 's/\([0-9]\+\.[0-9]\+\)\..*/\1/')
-    - cp build/linux/flatpak/org.gimp.GIMP-nightly.json.in build/linux/flatpak/org.gimp.GIMP-nightly.json
-    - sed -i "s/@GIMP_APP_VERSION@/$GIMP_APP_VERSION/g" build/linux/flatpak/org.gimp.GIMP-nightly.json
-
-    # GNOME script to customize the manifest
-    - rewrite-flatpak-manifest ${MANIFEST_PATH} ${FLATPAK_MODULE} ${CONFIG_OPTS}
-
-    # Build deps and GIMP
-    # (Our script is too long for Gitlab and no complete output would be collected
-    # To make debugging actually possible, let's save logs as a file.)
-    - flatpak-builder --ccache --user --disable-rofiles-fuse flatpak_app --repo=repo ${BRANCH:+--default-branch=$BRANCH} ${MANIFEST_PATH} &>flatpak-builder.log
-
-    # Generate a Flatpak bundle
-    - flatpak build-bundle repo ${BUNDLE} --runtime-repo=${RUNTIME_REPO} ${APP_ID} ${BRANCH}
-    - tar cf repo.tar repo/
   artifacts:
     paths:
       - flatpak-builder.log
-      # These are the same as flatpak_ci_initiative.yml as according to
-      # docs, key values are not merged but replaced.
       - gimp-git.flatpak
       - repo.tar
-      - '.flatpak-builder/build/gimp/_flatpak_build/meson-logs/meson-log.txt'
+      # FIXME: these can't be fetched, even if we bypass the symlink (module -> module-1)
-      - '.flatpak-builder/build/gimp/_flatpak_build/meson-logs/testlog.txt'
+      #        maybe also due to flatpak design?
+      # .flatpak-builder/build/babl-1/_flatpak_build/meson-logs/meson-log.txt
+      # .flatpak-builder/build/gegl-1/_flatpak_build/meson-logs/meson-log.txt
+      # .flatpak-builder/build/gimp-1/_flatpak_build/meson-logs/meson-log.txt
     expire_in: 2 days
 
 ## WINDOWS 64-bit CI (cross-build crossroad) ##
@@ -779,14 +744,18 @@ dev-docs:
       - gimp-api-docs-*.tar.xz.SHA512SUMS
     expire_in: 2 days
 
+include: 'https://gitlab.gnome.org/GNOME/citemplates/raw/master/flatpak/flatpak_ci_initiative.yml'
 dist-flatpak-weekly:
-  extends: '.publish_nightly'
+  extends:
+    - .default
+    - .publish_nightly
   rules:
     - if: '$CI_MERGE_REQUEST_LABELS =~ /.*5. Flatpak package.*/'
       interruptible: true
     - if: '$GIMP_CI_FLATPAK != null'
   needs: ["gimp-flatpak-x64"]
   stage: distribution
+  cache: []
   script:
     - if [ "$CI_COMMIT_BRANCH" != "$CI_DEFAULT_BRANCH" ]; then
         exit 0;

build/linux/flatpak/1_build-deps-flatpak.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+# Flatpak design mandates to build natively
+ARCH=$(uname -m)
+
+
+if [ -z "$GITLAB_CI" ]; then
+  # Make the script work locally
+  if [ "$0" != 'build/linux/flatpak/1_build-deps-flatpak.sh' ]; then
+    echo 'To run this script locally, please do it from to the gimp git folder'
+    exit 1
+  fi
+  flatpak update -y
+  export GIMP_PREFIX="$PWD/../_install-$ARCH"
+  if [ ! -d "$GIMP_PREFIX" ]; then
+    mkdir -p "$GIMP_PREFIX"
+  fi
+fi
+
+
+# Install part of the deps
+if [ -z "$GITLAB_CI" ]; then
+  flatpak remote-add --if-not-exists --user --from gnome-nightly https://nightly.gnome.org/gnome-nightly.flatpakrepo
+  flatpak install --user gnome-nightly org.gnome.Platform/$ARCH/master org.gnome.Sdk/$ARCH/master -y
+fi
+flatpak remote-add --if-not-exists --user --from flathub https://dl.flathub.org/repo/flathub.flatpakrepo
+flatpak install --user flathub org.freedesktop.Sdk.Extension.llvm17 -y
+
+
+# Clone and build the deps not present in GNOME runtime
+# (Flatpak design mandates to reinstall everything ('--force-clean') on the prefix)
+if [ -z "$GITLAB_CI" ]; then
+  flatpak-builder --force-clean --ccache --state-dir=../.flatpak-builder --keep-build-dirs --stop-at=gimp \
+                  "$GIMP_PREFIX" build/linux/flatpak/org.gimp.GIMP-nightly.json.in 2>&1 | tee flatpak-builder.log
+fi

build/linux/flatpak/2_build-gimp-flatpak.sh

@@ -0,0 +1,54 @@
+#!/bin/sh
+
+# Flatpak design mandates to build natively
+ARCH=$(uname -m)
+
+
+if [ -z "$GITLAB_CI" ]; then
+  # Make the script work locally
+  if [ "$0" != 'build/linux/flatpak/2_build-gimp-flatpak.sh' ]; then
+    echo 'To run this script locally, please do it from to the gimp git folder'
+    exit 1
+  fi
+  git submodule update --init
+  flatpak update -y
+  export GIMP_PREFIX="$PWD/../_install-$ARCH"
+
+
+  # Build GIMP only
+  if [ ! -f "_build-$ARCH/build.ninja" ]; then
+    mkdir -p _build-$ARCH && cd _build-$ARCH
+    flatpak-builder --run --ccache "$GIMP_PREFIX" ../build/linux/flatpak/org.gimp.GIMP-nightly.json.in meson setup .. -Dprefix=/app/ -Dlibdir=/app/lib/
+    if [ ! -f '.gitignore' ]; then
+      echo '*' > .gitignore
+    fi
+  else
+    cd _build-$ARCH
+  fi
+  flatpak-builder --run --ccache "$GIMP_PREFIX" ../build/linux/flatpak/org.gimp.GIMP-nightly.json.in ninja
+  flatpak-builder --run "$GIMP_PREFIX" ../build/linux/flatpak/org.gimp.GIMP-nightly.json.in ninja install
+
+
+else
+  export GIMP_PREFIX="$PWD/_install-$ARCH"
+
+  # Configure manifest (ugly but works on CI)
+  flatpak build-init "$GIMP_PREFIX" org.gimp.GIMP org.gnome.Sdk org.gnome.Platform
+  flatpak build "$GIMP_PREFIX" meson setup _build-$ARCH || echo "Generated log"
+  GIMP_APP_VERSION=$(grep 'Project version' _build-$ARCH/meson-logs/meson-log.txt | head -1 | sed -e 's/^.*[^0-9]\([0-9]*\.[0-9]*\.[0-9]*\).*$/\1/' -e 's/\([0-9]\+\.[0-9]\+\)\..*/\1/')
+  #flatpak build "$GIMP_PREFIX" meson setup _build-$ARCH -Dprefix=/app/ -Dlibdir=/app/lib/
+  #GIMP_APP_VERSION=$(grep GIMP_APP_VERSION config.h | head -1 | sed 's/^.*"\([^"]*\)"$/\1/')
+  cp -r build/linux/flatpak/org.gimp.GIMP-nightly.json.in build/linux/flatpak/org.gimp.GIMP-nightly.json
+  sed -i "s/@GIMP_APP_VERSION@/$GIMP_APP_VERSION/g" build/linux/flatpak/org.gimp.GIMP-nightly.json
+
+
+  # GNOME script to customize gimp module in the manifest (not needed)
+  #rewrite-flatpak-manifest build/linux/flatpak/org.gimp.GIMP-nightly.json gimp ${CONFIG_OPTS}
+
+
+  # Clone and build the deps not present in GNOME runtime (and GIMP)
+  # (The deps building is too long and no complete output would be collected,
+  # even from GitLab runner messages. So, let's silent and save logs as a file.)
+  flatpak-builder --force-clean --user --disable-rofiles-fuse --repo=repo ${BRANCH:+--default-branch=$BRANCH} \
+                  "$GIMP_PREFIX" build/linux/flatpak/org.gimp.GIMP-nightly.json &> flatpak-builder.log
+fi

build/linux/flatpak/4_dist-gimp-flatpak.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+# This script should be used only by 'dist-flatpak-weekly' job but
+# uploading repo/ in previous 'gimp-flatpak-x64' isn't possible
+# Let's keep the script, anyway, for clarity about the dist procedure
+
+
+# Generate a Flatpak bundle to be tested with GNOME runtime installed
+# (it is NOT a "real"/full bundle, deps from GNOME runtime are not bundled)
+flatpak build-bundle repo gimp-git.flatpak --runtime-repo=https://nightly.gnome.org/gnome-nightly.flatpakrepo org.gimp.GIMP ${BRANCH}
+
+# Only distribute on GNOME nightly if from 'master' branch
+if [ "$CI_COMMIT_BRANCH" != "$CI_DEFAULT_BRANCH" ]; then
+  exit 0
+fi
+
+# Prepare OSTree repo for GNOME nightly distribution
+tar cf repo.tar repo/
+
+# The following commands we take directly from 'flatpak_ci_initiative.yml'
+# See 'dist-flatpak-weekly' job